comparison docs/index.rst @ 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
comparison
equal deleted inserted replaced
69:2173ac4c2d9b 70:753974fc7619
56 requirements or dependencies. 56 requirements or dependencies.
57 57
58 Installation 58 Installation
59 ------------ 59 ------------
60 60
61 ``m209`` is available on the `Python Package Index`_ (PyPI). You can install it 61 ``m209`` is available on the `Python Package Index`_ (PyPI).
62 using pip_:: 62
63 You can install it using pip_::
63 64
64 $ pip install m209 # install 65 $ pip install m209 # install
65 $ pip install --upgrade m209 # upgrade 66 $ pip install --upgrade m209 # upgrade
66 67
67 You may also download a tarball or .zip file of the latest code by visiting the 68 You may also download a tarball or .zip file of the latest code by visiting the
68 Downloads tab on the `m209 Bitbucket page`_. Alternatively if you use 69 `m209 Bitbucket page`_. Alternatively if you use Mercurial_, you can clone the
69 Mercurial_, you can clone the repository with the following command:: 70 repository with the following command::
70 71
71 $ hg clone https://bitbucket.org/bgneal/m209 72 $ hg clone https://bitbucket.org/bgneal/m209
72 73
73 If you did not use pip, you can install with this command:: 74 If you did not use pip (you downloaded or cloned the code yourself), you can
75 install with::
74 76
77 $ cd where-you-extracted-m209
75 $ python setup.py install 78 $ python setup.py install
79
80 To run the unit tests::
81
82 $ cd where-you-extracted-m209
83 $ python -m unittest discover -b
76 84
77 Support & Source 85 Support & Source
78 ---------------- 86 ----------------
79 87
80 All support takes place at the `m209 Bitbucket page`_. Please enter any 88 All support takes place at the `m209 Bitbucket page`_. Please enter any