From b9adc2790e66254f34bbbbd5d7ca9f91e35ee87d Mon Sep 17 00:00:00 2001 From: Mike Yumatov Date: Fri, 9 Mar 2012 16:04:47 +0400 Subject: [PATCH] Add installation section to docs --- docs/index.rst | 1 + docs/installation.rst | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/installation.rst diff --git a/docs/index.rst b/docs/index.rst index f458998..40bc8a1 100644 --- 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 new file mode 100644 index 0000000..6e40b19 --- /dev/null +++ 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