Mercurial > public > m209
changeset 70:753974fc7619
Minor tweaks to install instructions. Added a note on how to run the tests.
| author | Brian Neal <bgneal@gmail.com> |
|---|---|
| date | Sun, 21 Jul 2013 14:30:12 -0500 |
| parents | 2173ac4c2d9b |
| children | 854c5d361011 |
| files | docs/index.rst |
| diffstat | 1 files changed, 13 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/index.rst Sun Jul 21 14:07:20 2013 -0500 +++ b/docs/index.rst Sun Jul 21 14:30:12 2013 -0500 @@ -58,22 +58,30 @@ Installation ------------ -``m209`` is available on the `Python Package Index`_ (PyPI). You can install it -using pip_:: +``m209`` is available on the `Python Package Index`_ (PyPI). + +You can install it using pip_:: $ pip install m209 # install $ pip install --upgrade m209 # upgrade You may also download a tarball or .zip file of the latest code by visiting the -Downloads tab on the `m209 Bitbucket page`_. Alternatively if you use -Mercurial_, you can clone the repository with the following command:: +`m209 Bitbucket page`_. Alternatively if you use Mercurial_, you can clone the +repository with the following command:: $ hg clone https://bitbucket.org/bgneal/m209 -If you did not use pip, you can install with this command:: +If you did not use pip (you downloaded or cloned the code yourself), you can +install with:: + $ cd where-you-extracted-m209 $ python setup.py install +To run the unit tests:: + + $ cd where-you-extracted-m209 + $ python -m unittest discover -b + Support & Source ----------------