diff options
| author | Kali Kaneko <kali@leap.se> | 2017-09-29 17:13:54 +0200 |
|---|---|---|
| committer | Kali Kaneko <kali@leap.se> | 2017-09-29 17:16:21 +0200 |
| commit | 0ae40c9f93deb39381a863e9b60dcb7142192021 (patch) | |
| tree | 01a4261d6eb142354014f8dc6cf6c8d19d7958e7 | |
| parent | d61e1fe94d65f039c1205e09453ff0ce183ea94d (diff) | |
[docs] add instructions for installing via pip
| -rw-r--r-- | docs/installation/index.rst | 30 |
1 files changed, 25 insertions, 5 deletions
diff --git a/docs/installation/index.rst b/docs/installation/index.rst index e278a5e..9713811 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -8,18 +8,38 @@ Installation and packaging ========================== -Users: go to the Bitmask Install guide https://bitmask.net/en/install +Here you can find instructions for developers and advanced users. For **user instructions**, you should refer to the official `Bitmask Install Guide`. You should only need to read the following sections if: -Translators: improved/new translations welcome! +* You plan to contribute code to bitmask core libraries. +* You intend to develop the Bitmask JS User Interface. +* You are a prospective maintainer for some platform yet unsupported. +* Your platform is unsupported by the official packages, and you want to install the python packages in your system. +If you want to contribute translations to some of these sections, please get in touch with us, it will be greatly appreciated to extend the community. + +.. _`Bitmask Install Guide`: https://bitmask.net/en/install + + +Installing with pip +------------------- + +If we still do not provide packages for your platform (debian/ubuntu only at the moment), and for some reason you cannot run the bundles we offer for download, you still should be able to run bitmask downloading the packages from pypi. First you will need some dependencies in your system, that very probably will be provided by your package manager:: + + lxpolkit openvpn gnupg1 python-pyside python-dev + +Now you can install the latest bitmask package from pypi:: + + pip install leap.bitmask[gui] + +If you want also to use the pixelated MUA, you need to install an additional extra:: + + pip install leap.bitmask[pixelated] -.. toctree:: - :hidden: Running latest code ------------------- -Refer to the :ref:`setting up the development environment <devenv>` section to +If you want to run latest code from git, you can refer to the :ref:`setting up the development environment <devenv>` section to learn how to run Bitmask from the latest code in the master branch. Building new bundles |