Add installation section to docs

xobb1t · Mar 9, 2012 · b9adc27 · b9adc27
1 parent 171081a
commit b9adc27
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,6 +18,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   installation
    api
 
 Indices and tables

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,27 @@
+Installation
+============
+
+You can install Gears with pip_::
+
+    $ pip install Gears
+
+It is strongly recommended to install Gears within activated virtualenv_.
+
+If you want to use one of available extensions (django-gears_, Flask-Gears_ or
+gears-cli_), please refer to its documentation instead.
+
+Installing the development version
+----------------------------------
+
+If you want to work with the latest version of Gears, install it from the
+public repository::
+
+    $ pip install -e https://github.com/trilan/gears@develop#egg=Gears
+
+
+.. _pip: http://www.pip-installer.org/
+.. _virtualenv: http://virtualenv.org/
+
+.. _django-gears: https://github.com/trilan/django-gears
+.. _flask-gears: https://github.com/trilan/flask-gears
+.. _gears-cli: https://github.com/trilan/flask-gears