diff --git a/README.md b/README.md index 5729e2f5..423e7a76 100644 --- a/README.md +++ b/README.md @@ -60,19 +60,9 @@ Note that the test scripts also run the example tests suites. - [Component](doc/component.md) - [QWeb](doc/qweb.md) -## Examples +# Examples There are two examples of how to work with this web framework: -- [Demo Application](examples/demo/readme.md) -- [Web Client](examples/web/readme.md) - -To play with the examples: - -``` -npm run example:build # make a build in dist/app/ -npm run example:dev # make a build in dist/app/, and make a live server to access it -``` - -The _example_:dev\_ task will build the app (without minification), then start a live-server with hot-reloading, and watch the file system to make sure -that assets are properly rebuilt if necessary, and then reloaded. +- [Demo Application](examples/readme.md#demo) +- [Web Client](examples/readme.md#web-client-example) diff --git a/examples/readme.md b/examples/readme.md new file mode 100644 index 00000000..11f8dc5e --- /dev/null +++ b/examples/readme.md @@ -0,0 +1,24 @@ +# Examples + +To play with the examples: + +``` +npm run example:build # make a build in dist/app/ +npm run example:dev # make a build in dist/app/, and make a live server to access it +``` + +The _example_:dev\_ task will build the app (without minification), then start a live-server with hot-reloading, and watch the file system to make sure +that assets are properly rebuilt if necessary, and then reloaded. + +## Web Client Example + +To test and play with the component class, there is a demo application located +in the _examples/web/_ folder. It is a rethink of what the web client could look like +if it is ever rebuilt from scratch. It is currently an experiment. But +obviously, we hope someday to be able to use this work and actually rewrite +completely the odoo web client. + +## Demo + +This example is just a playground to experiment/showcase some features of +the framework. diff --git a/examples/web/readme.md b/examples/web/readme.md deleted file mode 100644 index 1bd2f958..00000000 --- a/examples/web/readme.md +++ /dev/null @@ -1,7 +0,0 @@ -# Web Client Example - -To test and play with the component class, there is a demo application located -in the _examples/web/_ folder. It is a rethink of what the web client could look like -if it is ever rebuilt from scratch. It is currently an experiment. But -obviously, we hope someday to be able to use this work and actually rewrite -completely the odoo web client.