diff options
| author | k clair <kclair@riseup.net> | 2012-08-07 11:19:32 -0700 |
|---|---|---|
| committer | k clair <kclair@riseup.net> | 2012-08-07 11:19:32 -0700 |
| commit | ae7186e1f5686a1bebb99a708e4d43d2295a14b9 (patch) | |
| tree | 33c3c341ff1b14968db2095f7a530dd6c5daf80f | |
| parent | 36b0dfacca794e9cb899b5dde2dae3b8bbc6cc43 (diff) | |
updated README
| -rw-r--r-- | README.txt | 44 |
1 files changed, 33 insertions, 11 deletions
@@ -4,12 +4,34 @@ = your internet encryption toolkit = ======================================== +Installation +============= + +Dependencies +-------------- + +* python <= 2.7 +* python setuptools +* qt4 libraries +* python-qt4 +* python nose (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-setuptools python-nose + Install -======= +--------------- + +If not using virtualenv: +sudo python setup.py install + +If using virtualenv: python setup.py install -Running -======= + +Running the App +----------------- You need to set up a provider in your eip.cfg file: @@ -25,17 +47,15 @@ leap --debug (or python app.py --debug if you run it from the src/leap folder). +Development +============== + Running tests -============= +--------------- nosetests -v -[ currently broken ] - -Deps -==== -apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools Hack -==== +-------------- (recommended) virtualenv . # ensure your .gitignore knows about it @@ -47,10 +67,12 @@ bin/activate python setup.py develop # ... TBD: finish develop howto. 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 + |
