summaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/install.rst62
1 files changed, 36 insertions, 26 deletions
diff --git a/docs/user/install.rst b/docs/user/install.rst
index 2a597c8b..37a1713e 100644
--- a/docs/user/install.rst
+++ b/docs/user/install.rst
@@ -6,53 +6,50 @@ Installation
This part of the documentation covers the installation of Bitmask.
We assume that you want to get it properly installed before being able to use it.
-.. note::
-
- Methods described in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. You can refer to the sections :ref:`setting up a working environment <environment>` or :ref:`fetching latest code for testing <fetchinglatest>`.
-
Standalone bundle
-----------------
-You can run Bitmask using the standalone bundle, the recommended way to use Bitmask.
+Maybe the quickest way of running Bitmask in your machine is using the standalone bundle. That is the recommended way to use Bitmask for the time being.
-For the latest bundles and its signatures in https://downloads.leap.se/client/
+You can get the latest bundles, and their matching signatures at `the downloads page <https://downloads.leap.se/client/>`_.
-Linux 32 bits:
- https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2
+Linux
+^^^^^
+- `Linux 32 bits bundle`_ (`signature <https://downloads.leap.se/client/linux/Bitmask-linux32-latest.tar.bz2.asc>`_)
+- `Linux 64 bits bundle`_ (`signature <https://downloads.leap.se/client/linux/Bitmask-linux64-latest.tar.bz2.asc>`_)
- https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2.asc
+OSX
+^^^
+- `OSX bundle`_ (`signature <https://downloads.leap.se/client/osx/Bitmask-OSX-latest.dmg.asc>`_)
-Linux 64 bits:
- https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2
-
- https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2.asc
-
-OSX:
- https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg
+Windows
+^^^^^^^
+.. note::
- https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg.asc
+ The release of the bundles for Windows is delayed right now. We should resume
+ producing them shortly, keep tuned.
-Windows version is delayed right now.
+Signature verification
+^^^^^^^^^^^^^^^^^^^^^^
For the signature verification you can use ::
- $ gpg --verify Bitmask-linux64-0.3.1.tar.bz2.asc
+ $ gpg --verify Bitmask-linux64-latest.tar.bz2.asc
Asuming that you downloaded the linux 64 bits bundle.
-Distribute & Pip
-----------------
-
-Installing Bitmask is as simple as using `pip <http://www.pip-installer.org/>`_ for the already released versions ::
-
- $ pip install leap.bitmask
+.. _`PySide`: http://qt-project.org/wiki/PySide
+.. _`Linux 64 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux64-latest.tar.bz2
+.. _`Linux 32 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux32-latest.tar.bz2
+.. _`OSX bundle`: https://downloads.leap.se/client/osx/Bitmask-OSX-latest.dmg
+.. _`Windows bundle`: https://downloads.leap.se/client/osx/Bitmask-windows-latest.zip
Debian package
--------------
.. warning::
- The debian package in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead.
+ The debian package that you can currently find in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version or the standalone bundles while we upload the newest packages.
First, you need to bootstrap your apt-key::
@@ -71,6 +68,19 @@ And then you can happily install bitmask::
apt-get install bitmask
+Distribute & Pip
+----------------
+
+.. note::
+
+ The rest of the methods described below in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. For more insight, you can also refer to the sections :ref:`setting up a working environment <environment>` or :ref:`fetching latest code for testing <fetchinglatest>`.
+
+
+Installing Bitmask is as simple as using `pip <http://www.pip-installer.org/>`_ for the already released versions ::
+
+ $ pip install leap.bitmask
+
+
Show me the code!
-----------------