Changeset 8:042bf77e0223 in pyenvjasmine for README.rst

Timestamp:

Apr 20, 2015, 8:46:58 AM (9 years ago)

Author:

Borja Lopez <borja@…>

Branch:

default

Phase:

public

Message:

Added basic installation instructions, updated section on how to run pyenvjasmine tests

File:

• README.rst (modified) (3 diffs)

README.rst

@@ -5 +5 @@
 testing framework.
 
-.. _envjasmine : https://github.com/trevmex/EnvJasmine
+
+.. contents::
+
+
+Installation
+------------
+
+You can install pyenvjasmine using pip_ or easy_install_::
+
+  pip install pyenvjasmine
+
+::
+
+  easy_install pyenvjasmine
+
+Or you can grab the latest sources and install it from there::
+
+  python setup.py install
+
+Also, you can use it directly from the sources directory, in *development mode*
+(useful if you want to contribute to the project)::
+
+  python setup.py develop
+
+.. note::
+
+   More about the *development mode* here:
+
+   https://packaging.python.org/en/latest/distributing.html#working-in-development-mode
 
 
@@ -17 +45 @@
     nosetests --cover-package=pyenvjasmine --cover-erase \
     --with-coverage --with-doctest $*
+
+.. note::
+
+   If you have installed pyenvjasmine in *development mode*, you can simply
+   run::
+
+     nosetests
+
+   to run the tests.
 
 
@@ -52 +89 @@
             self.assertTrue('Failed: 0' in lines)
 
+
+.. _envjasmine : https://github.com/trevmex/EnvJasmine
+.. _pip: http://www.pip-installer.org/en/latest/index.html
+.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall