From 64622fe8158e4072650e73feae6e7dbd81d3370e Mon Sep 17 00:00:00 2001
From: Lukasz Balcerzak <lukaszbalcerzak@gmail.com>
Date: Fri, 14 Jun 2013 18:24:17 +0200
Subject: Created initial documentation for development environments -- related
 with #101

---
 doc/example/devenv.txt | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/examples.txt       |  1 +
 2 files changed, 65 insertions(+)
 create mode 100644 doc/example/devenv.txt

diff --git a/doc/example/devenv.txt b/doc/example/devenv.txt
new file mode 100644
index 0000000..02e307c
--- /dev/null
+++ b/doc/example/devenv.txt
@@ -0,0 +1,64 @@
+
+Development environment
+=======================
+
+Tox can be used to prepare development virtual environment for local projects.
+This feature can be useful in order to preserve environment across team members
+working on same project. It can be also used by deployment tools to prepare
+proper environments.
+
+*devenv* would be created at specific directory, not within ``.tox`` directory
+as other test environments. Other than that, configuration for this environment
+is very similar to other tox envs.
+
+
+Configuration
+-------------
+
+Firstly, you need to prepare configuration for your development environment. In
+order to do that, we must define proper section at ``tox.ini`` file and tell at
+what directory environment should be created. Moreover, we need to specify
+python version that should be picked::
+
+    [devenv]
+    envdir = devenv
+    basepython = python2.7
+
+
+Actually, you can configure a lot more, those are the only required settings.
+In example you can add ``deps`` and ``commands`` settings.
+
+
+.. note:: ``envdir`` should be *relative* path to where ``tox.ini`` is located.
+
+
+Creating development environment
+--------------------------------
+
+Once ``devenv`` section is defined we can instrument tox to create our
+environment::
+
+    tox --devenv
+
+This will create an environment at path specified by ``envdir`` under ``devenv``
+section.
+
+
+
+Full configuration example
+--------------------------
+
+Let's say we want our development environment sit at ``devenv``. We create this
+directory manually and put ``requirements.txt`` file there. We want to work on
+Python 2.7.
+
+Here is example configuration for that::
+
+    [devenv]
+    envdir = devenv
+    changedir = devenv
+    basepython = python2.7
+    commands =
+        pip install -r requirements.txt
+
+
diff --git a/doc/examples.txt b/doc/examples.txt
index 523a211..a3e9d91 100644
--- a/doc/examples.txt
+++ b/doc/examples.txt
@@ -11,4 +11,5 @@ tox configuration and usage examples
    example/nose.txt
    example/general.txt
    example/jenkins.txt
+   example/devenv.txt
 
-- 
cgit v1.2.1