summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJonas Haag <jonas@lophus.org>2011-06-08 17:49:34 +0200
committerJonas Haag <jonas@lophus.org>2011-06-08 17:49:34 +0200
commit5c22104b40646948f319c777836c093f8f6e78af (patch)
tree26cb1cff312113c0aa025c2aae1835b7607667fc /README.rst
parentd78d7590f76a22ecbd72e5c2a98432f072075a24 (diff)
Added a section about installing klaus in a virtualenv to README.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst25
1 files changed, 21 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 36d2d48..beaa7cf 100644
--- a/README.rst
+++ b/README.rst
@@ -16,16 +16,33 @@ klaus
Requirements
------------
* Python 2.7
-* Jinja2_ (``pip install jinja2``)
-* Pygments_ (``pip install pygments``)
-* dulwich_ (``pip install dulwich``)
-* Nano_ (``git submodule update --init``)
+* Jinja2_
+* Pygments_
+* dulwich_
+* Nano_ (shipped as submodule, do a ``git submodule update --init`` to fetch)
.. _Jinja2: http://jinja.pocoo.org/
.. _Pygments: http://pygments.org/
.. _dulwich: http://www.samba.org/~jelmer/dulwich/
.. _Nano: https://github.com/jonashaag/nano
+
+Installation
+------------
+*The same procedure as every year, James.* ::
+
+ virtualenv your-env
+ source your-env/bin/activate
+
+ pip install jinja2
+ pip install pygments
+ pip install dulwich
+
+ git clone https://github.com/jonashaag/klaus
+ cd klaus
+ git submodule update --init
+
+
Usage
-----
Using the ``quickstart.py`` script