summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorkali <kali@leap.se>2012-10-03 21:23:38 +0900
committerkali <kali@leap.se>2012-10-03 21:23:38 +0900
commit7a58425cbb090acb3777b602bd3350581f7b30e8 (patch)
treee10e737cf21218db85f0759634692569bc04a9d0 /README.txt
parentcc46c4eb9e616103c029531f71e15b3630d4809f (diff)
updated readme with some clarifications
hopefully it's a bit more clear now. developer: feedback welcome. are you able to get it running with the instructions listed here?
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt111
1 files changed, 0 insertions, 111 deletions
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 238cd1e3..00000000
--- a/README.txt
+++ /dev/null
@@ -1,111 +0,0 @@
-========================================
-= LEAP =
-= The LEAP Encryption Access Project =
-= your internet encryption toolkit =
-========================================
-
-Installation
-=============
-
-Dependencies
---------------
-
-* python <= 2.7
-* python setuptools
-* qt4 libraries
-* python-qt4
-* python-gnutls == 1.1.9
-* 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-gnutls libgnutls-dev python-setuptools python-nose
-
-Install
----------------
-
-Global install:
-sudo python setup.py install
-
-If using virtualenv:
-python setup.py install
-
-Install PyQt
-------------
-pip install PyQt will fail because PyQt4 does not use the standard setup.py mechanism.
-Instead, they use configure.py which generates a Makefile.
-
-python configure.py
-make && make install
-
-You can:
-
-* install PyQt globally and make a virtualenv with --site-packages
-* run pkg/install_pyqt.sh inside your virtualenv (with --no-site-packages)
-* run pkg/postmkvenv.sh after creating your virtualenv, for making symlinks to your global PyQt installation.
-
-
-Running the App
------------------
-
-leap-client --debug --logfile /tmp/leap.log
-
-If you're running a branded build, the script name will have a suffix that
-depends on your build flavor:
-
-leap-client-springbok
-
-(or python app.py --debug if you run it from the src/leap folder).
-
-Development
-==============
-
-Hack
---------------
-
-(recommended)
-virtualenv . # ensure your .gitignore knows about it
-source bin/activate
-git checkout develop
-pkg/postmkvenv.sh
-
-python setup.py branding
-python setup.py develop
-
-Running tests
--------------
-
-./run_tests.sh
-
-force no virtualenv and create coverage reports:
-./run_tests.sh -N -c
-
-if you want to run specific tests, pass the (sub)module to nose:
-
-nosetests leap.util
-
-or
-
-nosetests leap.util.test_leap_argparse
-
-Tox
----
-For running testsuite against all the supported python versions (currently 2.6 and 2.7), run:
-
-tox -v
-
-Test-deps
----------
-
-have a look at setup/test-requires
-
-
-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:
-
-make ui
-make resources