Browse Source

Added more installation documentation.

Jonas Borgström 12 years ago
parent
commit
445b862d8c
3 changed files with 46 additions and 1 deletions
  1. 4 0
      docs/global.rst.inc
  2. 2 1
      docs/index.rst
  3. 40 0
      docs/installation.rst

+ 4 - 0
docs/global.rst.inc

@@ -5,3 +5,7 @@
 .. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
 .. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
 .. _ACL: https://en.wikipedia.org/wiki/Access_control_list
 .. _ACL: https://en.wikipedia.org/wiki/Access_control_list
 .. _github: https://github.com/jborg/darc
 .. _github: https://github.com/jborg/darc
+.. _OpenSSL: https://www.openssl.org/
+.. _Python: http://www.python.org/
+.. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
+.. _homebrew: http://mxcl.github.io/homebrew/

+ 2 - 1
docs/index.rst

@@ -37,7 +37,7 @@ You can use pip to install |project_name| quickly and easily::
 
 
     $ pip install darc
     $ pip install darc
 
 
-Python >= 3.2 is required.
+Need more help with installing? See :ref:`installation`
 
 
 User's Guide
 User's Guide
 ============
 ============
@@ -45,6 +45,7 @@ User's Guide
 .. toctree::
 .. toctree::
    :maxdepth: 2
    :maxdepth: 2
 
 
+   installation
    generalusage
    generalusage
    faq
    faq
    definitions
    definitions

+ 40 - 0
docs/installation.rst

@@ -0,0 +1,40 @@
+.. include:: global.rst.inc
+.. _installation:
+
+Installation
+=============
+
+|project_name| requires Python_ 3.2 or above to work. Even though Python 3
+is not the default Python version on most Linux distributions it is usually
+available as an optional install.
+
+Other dependencies:
+
+* `msgpack-python`_ >= 0.1.10
+* OpenSSL_ >= 1.0.0
+
+The OpenSSL provided by Mac OS X is too old so OS X users are recommended
+to install a newer version using homebrew_.
+
+Installing from PyPI using pip
+------------------------------
+::
+
+    $ pip install darc
+
+Installing from source tarballs
+-------------------------------
+::
+
+    $ curl -O url
+    $ tar -xvzf darc-version.tar.gz
+    $ cd darc-version
+    $ python setup.py install
+
+Installing from git
+-------------------
+::
+
+    $ git clone https://github.com/jborg/darc.git
+    $ cd darc
+    $ python setup.py install