From 1f7a00c5061f5cd4ce0d5aa601a4b5eb5a98cbe3 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 3 Oct 2017 03:42:38 +0200 Subject: [docs] minor improvements - cross-refs to bitmask.net - wording - missing deps --- docs/hacking/devenv.rst | 5 ++--- docs/installation/index.rst | 23 ++++++++++++++++------- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/hacking/devenv.rst b/docs/hacking/devenv.rst index d7ad4157..029d7a3a 100644 --- a/docs/hacking/devenv.rst +++ b/docs/hacking/devenv.rst @@ -3,9 +3,8 @@ Setting a Development Environment ================================= - -Convencience script -~~~~~~~~~~~~~~~~~~~ +Convenience script +------------------ There is an automated script that runs, sequentially, all the commands in the section below. In debian-based systems, you can get a fully working development diff --git a/docs/installation/index.rst b/docs/installation/index.rst index e237aaad..4c8854f9 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -28,9 +28,13 @@ touch with us, it will be greatly appreciated to extend the community. 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:: +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 + lxpolkit openvpn gnupg1 python-pyqt5 python-dev libffi-dev Now you can install the latest bitmask package from pypi:: @@ -40,6 +44,8 @@ If you want also to use the pixelated MUA, you need to install an additional ext pip install leap.bitmask[pixelated] +.. _`bundles we offer for download`: https://bitmask.net/install + From git -------- @@ -90,14 +96,17 @@ involving docker, you can read more about the bundles in the :ref:`qa section Debian & ubuntu --------------- -ubuntu: -https://bitmask.net/en/install/linux#ubuntu-packages +Refer to the section in the install guide about the different `debian +repositories`_ that we provide to understand how the different packages are +produced. + +The debian packages are maintained in the ``debian/`` folder in the source code repo. -debian: -https://bitmask.net/en/install/linux#debian-packages +For a quick rebuild of local changes, you can do:: + debuild -us -uc -Building latest packages (TBD). +.. _`debian repositories`: https://bitmask.net/install/linux/deb Archlinux -- cgit v1.2.3