diff options
| author | Isis Lovecruft <isis@torproject.org> | 2013-01-14 22:22:24 +0000 |
|---|---|---|
| committer | Isis Lovecruft <isis@torproject.org> | 2013-01-14 22:22:24 +0000 |
| commit | 240b5849be48307ffce3f3a8530e130aae269986 (patch) | |
| tree | 2a499659b1762c40a4a7974f10474d9d3157b144 | |
| parent | 24e7234ed9ca3b130331d77f07f44b8951f9b1d0 (diff) | |
Updated README to include directions for virtualenv, and added requirements.txt file for pip.
| -rw-r--r-- | README.md | 29 | ||||
| -rw-r--r-- | requirements.txt | 2 |
2 files changed, 30 insertions, 1 deletions
@@ -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! diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..33b9b54 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +Twisted==12.2.0 +paisley>=0.3.1 |