diff options
| author | Kali Kaneko <kali@leap.se> | 2017-10-02 20:29:38 +0200 |
|---|---|---|
| committer | Kali Kaneko <kali@leap.se> | 2017-10-02 23:58:40 +0200 |
| commit | dd80e6083247446a44c22ac430620045aba287ef (patch) | |
| tree | 2013ff98dec0f38cc7dd30fbd7e095ab5c4dee51 /docs/installation | |
| parent | 0c497dbac737b6a92ad8662005fe152f7a9c1fe9 (diff) | |
[docs] split development docs
the page was becoming too cluttered.
Diffstat (limited to 'docs/installation')
| -rw-r--r-- | docs/installation/index.rst | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 11561c3..39efb56 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -5,23 +5,28 @@ .. _install: -Installation and packaging -========================== +Installation +============ -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: +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: * 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. +* 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. +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 +.. _pip: -Installing with pip -------------------- +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:: @@ -36,14 +41,15 @@ If you want also to use the pixelated MUA, you need to install an additional ext pip install leap.bitmask[pixelated] -Running latest code -------------------- +From git +-------- -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. +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 --------------------- +Building bundles +---------------- The standalone bundles are built with PyInstaller. @@ -76,7 +82,7 @@ A new bundle is created by the CI for every commit using this procedure involving docker, you can read more about the bundles in the :ref:`qa section <qa>`. -Debian packages +Debian & ubuntu --------------- ubuntu: |