summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDoug Hellmann <doug.hellmann@dreamhost.com>2012-10-21 15:46:54 -0400
committerDoug Hellmann <doug.hellmann@dreamhost.com>2012-10-21 15:46:54 -0400
commit77fa6aeff636a8078dcdc871e93b837ad4083377 (patch)
treed641ebf4e7e3e2d25aa1979323299cc4f393c258
parent621694709a863dc4b0ffa9275617e6678177322e (diff)
downloadcliff-77fa6aeff636a8078dcdc871e93b837ad4083377.tar.gz
Document dependency on distribute
Update the installation instructions to include information about using Distribute instead of setuptools. Addresses issue #20 Change-Id: If09d63481fbc961a29be81f6c627c8c1c992020b Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
-rw-r--r--docs/source/install.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/install.rst b/docs/source/install.rst
index 1bd67d0..ad9a211 100644
--- a/docs/source/install.rst
+++ b/docs/source/install.rst
@@ -7,6 +7,20 @@ Python Versions
cliff is being developed under Python 2.7 and tested with Python 3.2.
+Dependencies
+============
+
+cliff depends on distribute_, the updated replacement for
+setuptools. If you have an older version of setuptools installed, `you
+may have trouble installing cliff`_ until you upgrade or set up a
+virtualenv_ using distribute instead (by using ``--use-distribute``).
+
+.. _distribute: http://pypi.python.org/pypi/distribute
+
+.. _you may have trouble installing cliff: https://bitbucket.org/tarek/distribute/issue/91/install-glitch-when-using-pip-virtualenv
+
+.. _virtualenv: http://pypi.python.org/pypi/virtualenv
+
.. _install-basic:
Basic Installation