From 3338db672a92b440f602ecde667c9e02ad857e38 Mon Sep 17 00:00:00 2001 From: Francisco Souza Date: Sun, 20 Nov 2011 01:35:30 -0200 Subject: [PATCH] Some improvements on README (including some info on how to contribute developing roan itself and where the source and the issues are hosted) --- README.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.rst b/README.rst index 83d21e3..5e9c328 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ +* Report issues on `GitHub 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 `_ 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