From 445b862d8c16da3c3767e6bc68a487749c56bb8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Borgstr=C3=B6m?= Date: Sun, 30 Jun 2013 21:30:17 +0200 Subject: [PATCH] Added more installation documentation. --- docs/global.rst.inc | 4 ++++ docs/index.rst | 3 ++- docs/installation.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 docs/installation.rst diff --git a/docs/global.rst.inc b/docs/global.rst.inc index f8acef377..accfa51a0 100644 --- a/docs/global.rst.inc +++ b/docs/global.rst.inc @@ -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/ diff --git a/docs/index.rst b/docs/index.rst index 5d62de85f..6177d9300 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 000000000..1e9ed3f57 --- /dev/null +++ b/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