Skip to content
This repository has been archived by the owner on Nov 28, 2019. It is now read-only.

Commit

Permalink
Some improvements on README (including some info on how to contribute…
Browse files Browse the repository at this point in the history
… developing roan itself and where the source and the issues are hosted)
  • Loading branch information
fsouza committed Nov 20, 2011
1 parent 48eefed commit 3338db6
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,32 @@ Here is the code for the example above, of purging the ``/posts`` URL whenever a

purge("/posts").on_save(Post)
purge("/posts").on_delete(Post)

Development
-----------

* Source hosted at `GitHub <http://github.com/cobrateam/roan>`_
* Report issues on `GitHub Issues <http://github.com/cobrateam/roan/issues>`_

Pull requests are very welcome! Make sure your patches are well tested.

setting up the development environment
++++++++++++++++++++++++++++++++++++++

To setup the development environment, just run:

::

$ make bootstrap

This command will install all the development dependencies. It assumes you're using `virtualenv <http://pypi.python.org/pypi/virtualenv>`_ and don't
use ``sudo`` to install the dependencies. If you want to use the Python of your system, use ``sudo`` to run the ``make bootstrap`` command.

running the test suite
++++++++++++++++++++++

``make`` is also used to run the tests of the application:

::

$ make test

0 comments on commit 3338db6

Please sign in to comment.