Added more installation documentation.

This commit is contained in:
Jonas Borgström 2013-06-30 21:30:17 +02:00
parent a32c5651c1
commit 445b862d8c
3 changed files with 46 additions and 1 deletions

View File

@ -5,3 +5,7 @@
.. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
.. _ACL: https://en.wikipedia.org/wiki/Access_control_list
.. _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/

View File

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

40
docs/installation.rst Normal file
View File

@ -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