NextERP/owl
2
0
Fork 0
mirror of https://github.com/odoo/owl.git synced 2025-10-06 19:59:41 +07:00
Code Issues Packages Projects Releases Wiki Activity

doc: improve readme.md

Browse Source
This commit is contained in:
Géry Debongnie
2019-03-28 10:45:40 +01:00
parent d804bcf2dd
commit 7ac4e63e51
1 changed files with 9 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -20
View File
@@ -1,4 +1,4 @@
<p align="center" style="font-weight: bold;font-size: 32px;color: cadet-blue;">🦉 Odoo Web Lab 🦉</p> <h1 align="center">🦉 Odoo Web Lab 🦉</h1>
## Project Overview ## Project Overview
@@ -30,26 +30,15 @@ client will ever be converted to typescript (even though I would really like it)
## Installing/Building ## Installing/Building
To install every dependency needed to play with this code: Some npm scripts are available:
``` | Command | Description |
npm install | ------------------ | -------------------------------------------------- |
``` | npm install | install every dependency required for this project |
| npm run build | build a bundle of _owl_ in the _/dist/_ folder |
To build a bundle of this as a library: | npm run minify | minify the prebuilt owl.js file |
| npm run test | run all tests |
``` | npm run test:watch | run all tests, and keep a watcher |
npm run build
```
To run tests:
```
npm run test
npm run test:watch
```
Note that the test scripts also run the example tests suites.
## Documentation ## Documentation