From 9788a37e04ade4224a9b947171b5504ffdf266af Mon Sep 17 00:00:00 2001
From: Isis Lovecruft <isis@torproject.org>
Date: Tue, 19 Feb 2013 05:55:01 +0000
Subject: Add update to documentation explaining the bootstrap script and
 install process.

---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 52 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 05422c2..52d6d16 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,69 @@
 leap_mx
 =======
+**Note:** Currently in development. Feel free to test, and please [report
+ bugs](mailto:isis@leap.se).
 
-**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.
 
-An asynchronous, transparently-encrypting remailer for the LEAP platform, using BigCouch/CouchDB and PGP/GnuPG, written in Twisted Python.
-
-## [install](#install) {#install} ##
+## [install](#install) ##
 =========================
+[tl;dr](#tl;dr)
+
+### [virtualenv](#virtualenv) ###
+=================================
+Virtualenv is somewhat equivalent to fakeroot for python packages, and -- due
+to being packaged with copies of pip and python -- can be used to bootstrap
+its own install process, allowing pip and python to be used with sudo.
+
+#### [installing without sudo] ####
 
-**tl;dr:** To get started quickly do:
+To install without using sudo, a bootstrap script to handle the setup process
+is provided. It does the following:
 
- # pip install -r requirements.txt
+ 1. Download, over SSL, the latest tarballs for virtualenv and
+ virtualenvwrapper from pypi.
+ 2. Unpack the tarballs, use the system python interpreter to call the
+ virtualenv.py script to setup a bootstrap virtual environment.
+ 3. Use the pip installed in the bootstrap virtualenv to install
+ virtualenvwrapper in the bootstrap virtualenv.
+ 4. Obtain a copy of leap_mx with git clone.
+ 5. Use ```mkvirtualenv``` included in the virtualenvwrapper inside the
+ bootstrap virtualenv to install a project virtualenv for leap_mx. 
+
+To use the bootstrap script, do:
+~~~
+$ wget -O bootstrap https://raw.github.com/isislovecruft/leap_mx/fix/no-suid-for-virtualenv/bootstrap
+$ ./bootstrap
+$ workon leap_mx
+~~~
 
-Although, **it is advised** to install inside a python virtualenv. To install python, virtualenv, and get started, do:
+#### [installing in a regular virtualenv] ###
+To install python, virtualenv, and get started, do:
 
 ~~~
-$ sudo apt-get install python2.7 python-pip python-virtualenv python-dev
-$ pip install virtualenvwrapper
-$ cd
+$ sudo apt-get install python2.7 python-dev python-virtualenv virtualenvwrapper
 $ git clone https://github.com/isislovecruft/leap_mx.git leap_mx
-$ export WORKON_LEAPMX=~/leap_mx
+$ export WORKON_LEAPMX=${PWD}/leap_mx
 $ source /usr/local/bin/virtualenvwrapper.sh
-$ mkvirtualenv -a $WORKON_LEAPMX -r ${WORKON_LEAPMX}/requirements.txt \
+$ mkvirtualenv -a $WORKON_LEAPMX -r ${WORKON_LEAPMX}/pkg/mx-requirements.pip \
       --no-site-packages --setuptools --unzip-setuptools leap_mx
 ~~~
 
-## [running](#running) {#running} ##
+### [tl;dr](#tl;dr) ###
+To get started quickly, without virtualenv, do:
+~~~
+$ sudo apt-get install python git
+$ git clone https://github.com/isislovecruft/leap_mx.git
+# pip install -r ./leap_mx/pkg/mx-requirements.pip
+~~~
+Although, **it is advised** to install inside a python virtualenv. 
+
+## [running](#running) ##
 =========================
 
-Hold your horses, boy. This isn't ready yet -- check back later!
+To get running, clone this repo, and (assuming you've already set up your virtualenv and obtained all the requirements) do:
+
+~~~
+$ ./start_mx.py --help
+~~~
\ No newline at end of file
-- 
cgit v1.2.3