diff options
| author | kennyballou <kballou@onyx.boisestate.edu> | 2013-02-21 09:05:56 -0700 |
|---|---|---|
| committer | kennyballou <kballou@onyx.boisestate.edu> | 2013-02-21 09:05:56 -0700 |
| commit | 7012168ffe108a261645669ec37f2b22dbcdef8c (patch) | |
| tree | 3e2b85e5288fdf876350f8e32e7954932facd54f /docs | |
| parent | bddaf30a35a0d32ce38176a98c986099c35dd3a6 (diff) | |
| download | xnt-7012168ffe108a261645669ec37f2b22dbcdef8c.tar.gz xnt-7012168ffe108a261645669ec37f2b22dbcdef8c.tar.xz | |
Update Install Instructions
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/index.rst | 42 |
1 files changed, 32 insertions, 10 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index 164ea36..03b1cbb 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -68,31 +68,53 @@ To install, you can either install from source or use Pip. Source ------ -To install from Source (stable), run the following:: +To install from Source (stable), run the following: - curl -0 http://pypi.python.org/packages/source/X/Xnt/Xnt-0.2.3.tar.gz \ +.. parsed-literal:: + + curl -0 http://pypi.python.org/packages/source/X/Xnt/Xnt-|release|.tar.gz \ > Xnt.tar.gz tar -xzvf Xnt.tar.gz - cd Xnt-0.2.3 - python setup.py install --user + cd Xnt-|release| + python[2] setup.py install [--user] Development Build ----------------- To build and install from a development build(non-stable/ testing), run:: - curl -0 https://bitbucket.org/devnulltao/xnt/get/default.tar.gz \ - > Xnt.tar.gz - tar -xzvf Xnt.tar.gz - cd default - python setup.py install --user + git clone git://github.com/devnulltao/Xnt.git + cd Xnt + python[2] setup.py install [--user] + + +Or if you prefer, you can download a zip of the latest build and install; run:: + + curl -0 https://github.org/devnulltao/Xnt/archive/master.zip > Xnt.zip + unzip Xnt.zip + cd Xnt + python[2] setup.py install [--user] Pip --- To install using Pip, run:: - pip install Xnt --user + pip[2] install Xnt [--user] + +Using `--user` +-------------- + +If you install using the ``--user`` option in either source or PyPi installs, +you may need to add ``~/.local/bin/`` to your ``PATH`` environment variable. + +Windows +------- + +If on windows, after installing you will need to edit your ``PATH`` environment +variable to include the installation location (either +``<python_install_dir>\Scripts`` or ``$HOME\AppData\Roaming\Python\Scripts``). + Indices and tables ================== |