From 240b5849be48307ffce3f3a8530e130aae269986 Mon Sep 17 00:00:00 2001
From: Isis Lovecruft <isis@torproject.org>
Date: Mon, 14 Jan 2013 22:22:24 +0000
Subject: Updated README to include directions for virtualenv, and added
 requirements.txt file for pip.

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 7022d47..8864866 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,31 @@
 leap_mx
 =======
 
-A transparent, encrypting remailer for the LEAP platform, using BigCouch and GPG.
\ No newline at end of file
+**Note:** Currently in development. Feel free to test, and please [report bugs](mailto:isis@leap.se).
+
+An asynchronous, transparently-encrypting remailer for the LEAP platform, using BigCouch/CouchDB and PGP/GnuPG, written in Twisted Python.
+
+## [install](#install) ##                 {#install}
+=========================
+
+**tl;dr:** To get started quickly do:
+
+ # pip install -r requirements.txt
+
+Although, **it is advised** to install inside a python virtualenv. To install python, virtualenv, and get started, do:
+
+~~~
+$ sudo apt-get install python2.7 python-pip virtualenv
+$ pip install virtualenvwrapper
+$ cd
+$ git clone https://github.com/isislovecruft/leap_mx.git leap_mx
+$ export WORKON_LEAPMX=~/leap_mx
+$ source /usr/local/bin/virtualenvwrapper.sh
+$ mkvirtualenv -a $WORKON_LEAPMX -r ${WORKON_LEAPMX}/requirements.txt \
+      --no-site-packages --setuptools --unzip-setuptools leap_mx
+~~~
+
+## [running](#running) ##               {#running}
+=========================
+
+Hold your horses, boy. This isn't ready yet -- check back later!
-- 
cgit v1.2.3