diff options
| author | Kali Kaneko <kali@leap.se> | 2014-03-17 11:03:52 -0400 |
|---|---|---|
| committer | Kali Kaneko <kali@leap.se> | 2014-03-17 11:03:52 -0400 |
| commit | f78a694b283859e4eab306dffaa0373b9f6ea8ad (patch) | |
| tree | cf93ae194f840891e9eba6cda5b296b6b5446ea4 /README.rst | |
| parent | c0ac189e565c9cfc453db4d1ef77cc4c48f17584 (diff) | |
| parent | 8bd80cfa21de0edd5bb0b0d1d28a8fce167a0921 (diff) | |
Merge remote-tracking branch 'ivan-github/feature/remove-docs-from-readme' into develop
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 101 |
1 files changed, 3 insertions, 98 deletions
@@ -17,111 +17,16 @@ Currently we distribute pre-compiled `bundles`_ for Linux, OSX and Windows. .. _`PySide`: http://qt-project.org/wiki/PySide .. _`the LEAP Platform`: https://github.com/leapcode/leap_platform -.. _`bundles`: https://downloads.leap.se/client/ +.. _`bundles`: https://dl.bitmask.net Read the Docs! ------------------ -The latest documentation is available at `Read The Docs`_. +The latest documentation is available at `LEAP`_. -.. _`Read The Docs`: http://bitmask.rtfd.org +.. _`LEAP`: https://leap.se/en/docs/client -Dependencies ------------------- - -Bitmask depends on these libraries: - -* ``python 2.6`` or ``2.7`` -* ``qt4 libraries`` -* ``libopenssl`` -* ``openvpn`` - -Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requirements.pip`` - -Getting dependencies under debian -++++++++++++++++++++++++++++++++++ - -With a Debian based system, to be able to run Bitmask you need to run the following command:: - - $ sudo apt-get install git python-dev python-setuptools - python-virtualenv python-pip python-openssl libsqlite3-dev g++ openvpn - pyside-tools python-pyside libffi-dev - -Installing ------------ - -Quick install, from the cheese shop:: - - $ sudo pip install leap.bitmask - -If you prefer to install from sources:: - - $ make - $ sudo python2 setup.py install - - -Running -------- - -After a successful installation, there should be a launcher called ``bitmask`` somewhere in your path:: - - $ bitmask - -If you are testing a new provider and do not have a CA certificate chain tied to your SSL certificate, you should execute Bitmask in the following way:: - - $ bitmask --danger - -But **DO NOT use it on a regular basis**. - -**WARNING**: If you use the --danger flag you may be victim to a MITM_ attack without noticing. Use at your own risk. - -.. _MITM: http://en.wikipedia.org/wiki/Man-in-the-middle_attack - -Hacking -======= - -Get the source from the main Bitmask repo:: - - git clone https://leap.se/git/bitmask_client - -The code is also browsable online at:: - - https://leap.se/git/?p=bitmask_client.git - -Some steps need to be run when setting a development environment for the first time. - -Enable a **virtualenv** to isolate your libraries. (Current *.gitignore* knows about a virtualenv in the root tree. If you do not like that place, just change ``.`` for *<path.to.environment>*):: - - $ virtualenv . - $ source bin/activate - -Make sure you are in the development branch:: - - (bitmask)$ git checkout develop - -Symlink your global pyside libraries:: - - (bitmask)$ pkg/postmkvenv.sh - -And make your working tree available to your pythonpath:: - - (bitmask)$ python2 setup.py develop - -Run Bitmask:: - - (bitmask)$ bitmask --debug - -Testing -======= - -Have a look at ``pkg/test-requirements.pip`` for the tests dependencies. - -To run the test suite:: - - $ ./run_tests.sh - -which the first time should automagically install all the needed dependencies in your virtualenv for you. License ======= |