From 89eedff7af5424c69984a696ffb1cd2a8992f606 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Mon, 21 Oct 2013 14:14:32 -0200 Subject: add readme and changelog to long-description reformat changelog in .rst --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index a4272c40..811cfdfa 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,6 +8,7 @@ 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. @@ -35,7 +37,7 @@ 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:: -- cgit v1.2.3 From 56402b3820361e7a606b38a5aa76a30282c63c18 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Mon, 21 Oct 2013 15:22:44 -0200 Subject: add downloads link; mention windows support --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 811cfdfa..7a8329b9 100644 --- a/README.rst +++ b/README.rst @@ -10,11 +10,11 @@ Bitmask `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! -- cgit v1.2.3 From 297694e06ffb1eb4b191cbc164bd1d7a8ba5f46b Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 16 Oct 2013 16:39:13 -0300 Subject: Update apt-get dependencies * Also, tweak different sections to be consistent with the new quickstart. * Squashed contributions by Jeremy (@bneg) * add note about authors.rst --- README.rst | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 7a8329b9..a9af236e 100644 --- a/README.rst +++ b/README.rst @@ -41,7 +41,9 @@ 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 ----------- @@ -102,13 +104,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 ======= -- cgit v1.2.3 From e4ede90a3e20bd9b023fed12d6d72db3fcc380ab Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 22 Oct 2013 11:20:20 -0200 Subject: add pip install --- README.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index a9af236e..4bebc180 100644 --- a/README.rst +++ b/README.rst @@ -48,10 +48,15 @@ With a Debian based system, to be able to run Bitmask you need to run the follow 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 ------- -- cgit v1.2.3