From bda0f214d13387e4efceb127f0a8bbb37935f98c Mon Sep 17 00:00:00 2001
From: k clair <kclair@riseup.net>
Date: Tue, 7 Aug 2012 11:19:32 -0700
Subject: updated README

cherry-picked kclair updates on buildbot branch into develop branch.
---
 README.txt | 51 ++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 38 insertions(+), 13 deletions(-)

(limited to 'README.txt')

diff --git a/README.txt b/README.txt
index bb6f0826..510bda58 100644
--- a/README.txt
+++ b/README.txt
@@ -4,12 +4,34 @@
 =   your internet encryption toolkit   =
 ========================================
 
+Installation
+=============
+
+Dependencies
+--------------
+
+* python <= 2.7
+* python setuptools
+* qt4 libraries
+* python-qt4
+* python-nose, python-mock, python-coverage (if you want to run tests)
+
+If you are on a debian-based system, you can run:
+
+apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-setuptools python-nose
+
 Install
-=======
+---------------
+
+If not using virtualenv:
+sudo python setup.py install
+
+If using virtualenv:
 python setup.py install
 
-Running
-=======
+
+Running the App
+-----------------
 
 You need to set up a provider in your eip.cfg file:
 
@@ -25,8 +47,11 @@ leap --debug
 
 (or python app.py --debug if you run it from the src/leap folder).
 
+Development
+==============
+
 Running tests
-=============
+-------------
 
 ./run_tests.sh
 
@@ -38,18 +63,14 @@ or
 
 nosetests leap.util.test_leap_argparse
 
-Deps
-====
-
-apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools
 
 Test-deps
-=========
+---------
 
-test-requires
+have a look at setup/test-requires
 
 Hack
-====
+--------------
 
 (recommended)
 virtualenv .  # ensure your .gitignore knows about it
@@ -58,10 +79,14 @@ bin/activate
 # you should probably simlink sip.so and PyQt4 to your system-wide
 # install, there are some issues with it.
 
-python setup.py develop  # ... TBD: finish develop howto.
+python setup.py develop  
+
+# ... TBD: finish develop howto.
+# ... and explain how is python setup develop useful.
 
 Compiling resource/ui files
-===========================
+-----------------------------
+
 You should refresh resource/ui files every time you
 change an image or a resource/ui (.ui / .qc). From
 the root folder:
-- 
cgit v1.2.3