summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorTomás Touceda <chiiph@leap.se>2013-11-01 10:50:38 -0300
committerTomás Touceda <chiiph@leap.se>2013-11-01 10:50:38 -0300
commit23e9034664edf6b2a01a677c4fa4e6efd880e364 (patch)
treefc90f154cf81cbaf48dd2d4a738a379591c4e7c7 /README.rst
parenta06b5719f028e619a4b3800fb346ed3c984e4d25 (diff)
parent80fde752f0bf7946869361f6a77d1952f9339636 (diff)
Merge branch 'release-0.3.6'0.3.6
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst30
1 files changed, 16 insertions, 14 deletions
diff --git a/README.rst b/README.rst
index a4272c40..4bebc180 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,6 @@
Bitmask
=======
+
*your internet encryption toolkit*
.. image:: https://pypip.in/v/leap.bitmask/badge.png
@@ -7,12 +8,13 @@ Bitmask
**Bitmask** is the multiplatform desktop client for the services offered by
`the LEAP Platform`_.
+
It is written in python using `PySide`_ and licensed under the GPL3.
-Currently we distribute pre-compiled bundles for Linux and OSX, with Windows
-bundles following soon.
+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/
Read the Docs!
@@ -35,19 +37,26 @@ Bitmask depends on these libraries:
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 openvpn python-pyside pyside-tools python-setuptools python-all-dev python-pip python-dev python-openssl
+ $ sudo apt-get install git python-dev python-setuptools
+ python-virtualenv python-pip python-openssl libsqlite3-dev g++ openvpn
+ pyside-tools python-pyside
Installing
-----------
-After getting the source and installing all the dependencies, proceed to install ``bitmask`` package::
+Quick install, from the cheese shop::
+
+ $ sudo pip install leap.bitmask
+
+If you prefer to install from sources::
+
+ $ make
+ $ sudo python2 setup.py install
- $ make
- $ sudo python2 setup.py install
Running
-------
@@ -100,13 +109,6 @@ Run Bitmask::
(bitmask)$ bitmask --debug
-
-If you are testing a new provider that doesn't have the proper certificates yet, you can use --danger flag, 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
-
Testing
=======