summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.txt b/README.txt
index 14ac253f..4a4ae52f 100644
--- a/README.txt
+++ b/README.txt
@@ -1,15 +1,34 @@
========================================
= LEAP =
-= The Internet Encryption Toolkit =
+= The LEAP Encryption Access Project =
+= your internet encryption toolkit =
========================================
Install
=======
python setup.py install
+Running
+=======
+
+You need to set up a provider in your eip.cfg file:
+
+cd ~/.config/leap
+vim eip.cfg
+
+[provider]
+remote_ip = XXX.XXX.XXX.XXX
+
+and then run:
+
+leap --debug
+
+(or python app.py --debug if you run it from the src/leap folder).
+
Running tests
=============
nosetests -v
+[ currently broken ]
Deps
====