Skip to content

Commit

Permalink
Add developer notes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
verma committed Mar 9, 2014
1 parent 520df43 commit 0920e68
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,34 @@ When will it support X, Y, or Z?
are going to be the most persuasive way to impact its future
development.

Developers
...............................................................................
Plasio uses the Gulp_ build system::

npm install -g gulp
You can build and stage files under the ``build`` directory by running::

gulp
While developing, you may run::
gulp develop
This will serve built files locally and open your default browser pointing to the index page. Any changes you make to
source files will fire gulp tasks that will keep the ``build`` directory up to date. The build system also uses
gulp's live-reload plugin, which works great with `Google Chrome's Live Reload`_ extension.

The gulp file includes a task to publish directly to plas.io, however, you need AWS Access for that to work. You may direct plasio
to your own AWS buckets, in which case you will have to edit ``gulpfile.js`` to direct it likewise.

The publish task looks for ``~/.aws.json`` which should include two fields, ``key`` and ``secret``.

To publish to AWS simply run::

gulp publish


License
...............................................................................

Expand All @@ -49,4 +77,6 @@ The software is licensed under the permissive `MIT`_ license.
.. _`LASzip`: http://laszip.org
.. _`NaCl`: https://developers.google.com/native-client/dev/
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`Mac and Windows Chrome Canary`: https://www.google.com/intl/en/chrome/browser/canary.html
.. _`Mac and Windows Chrome Canary`: https://www.google.com/intl/en/chrome/browser/canary.html
.. _`Gulp`: http://gulpjs.com/
.. _`Google Chrome's Live Reload`: https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en

0 comments on commit 0920e68

Please sign in to comment.