summaryrefslogtreecommitdiff
path: root/docs/installation/index.rst
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2017-04-21 14:32:51 +0200
committerKali Kaneko (leap communications) <kali@leap.se>2017-04-21 14:32:51 +0200
commitbdbaebef8e9bc6e0ef58252a790d8433d5c67fe6 (patch)
tree02ba27acc308d5dd8e08f68a0c603060ef6f817e /docs/installation/index.rst
parentf31b9cab88c543f6b2b3910411a872ab0636e508 (diff)
[docs] several doc updates
Diffstat (limited to 'docs/installation/index.rst')
-rw-r--r--docs/installation/index.rst43
1 files changed, 36 insertions, 7 deletions
diff --git a/docs/installation/index.rst b/docs/installation/index.rst
index ce119e6..e278a5e 100644
--- a/docs/installation/index.rst
+++ b/docs/installation/index.rst
@@ -5,8 +5,8 @@
.. _install:
-Installation
-==================
+Installation and packaging
+==========================
Users: go to the Bitmask Install guide https://bitmask.net/en/install
@@ -18,13 +18,43 @@ Translators: improved/new translations welcome!
Running latest code
-------------------
-blah blah
+
+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
--------------------
-blah blah...
-nightly builds...
-building bleeding edge bundles...
+
+The standalone bundles are built with PyInstaller.
+
+If you are inside a development virtualenv, you should be able to install it
+together with some extra development dependencies with::
+
+ pip install -r pkg/requirements-dev.pip
+
+And then just do::
+
+ make bundle
+
+To build a new bundle.
+
+There's also a script that automates re-creating the virtualenv from which the
+packaging takes place::
+
+ pkg/build_bundle_with_venv.sh
+
+To ensure a repeatable system-wide environment, you can build those bundles from
+within a docker container. First you need to create the container::
+
+ make docker_container
+
+and then you can launch the above script inside that container::
+
+ make bundle_in_docker
+
+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
---------------
@@ -35,7 +65,6 @@ https://bitmask.net/en/install/linux#ubuntu-packages
debian:
https://bitmask.net/en/install/linux#debian-packages
-Experimental repo ...
Building latest packages (TBD).