Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rodfersou authored and hvelarde committed Oct 24, 2018
1 parent 749ba2f commit 3537dea
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.rst
Expand Up @@ -153,6 +153,41 @@ Check the box next to ``collective.cover`` and click the 'Activate' button.
You may have to empty your browser cache and save your resource registries
in order to see the effects of the product installation.

Development
^^^^^^^^^^^

We use `webpack <https://webpack.js.org/>`_ to process static resources on this package.
Webpack processes SCSS and JS files, minifies the resulting CSS and JS, and optimizes all images.
The final JS file is also a UMD package, which provides compatibility with most popular script loaders.

To contribute, you should start the instance in one shell and start webpack watcher on another with the following command:

.. code-block:: bash
$ bin/watch-cover
Then go to ``webpack/app`` folder and edit SCSS and JS files;
Webpack watcher will automatically create the final resources in the right place.

There are also other commands added to handle more complex scenarios.
The following command will set the buildout node installation in the system PATH, this way you can use webpack as described on its documentation.

.. code-block:: bash
$ bin/env-cover
The following command generates JS and CSS without the minify step (it can be used to check the code being generated in a human readable way).

.. code-block:: bash
$ bin/debug-cover
The following command rebuilds static files and exit (insted of keep watching the changes):

.. code-block:: bash
$ bin/build-cover
Upgrading from 1.x to 2.x
^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 3537dea

Please sign in to comment.