[docs] document the dev-bootstrap script

parent 1175a0b3
Pipeline #4318 passed with stages
in 40 minutes and 49 seconds
......@@ -4,6 +4,9 @@ DIST_VERSION = dist/bitmask-$(NEXT_VERSION)/
include pkg/pyinst/build.mk
include pkg/thirdparty/openvpn/build.mk
pip install -e '.[mail]'
......@@ -72,8 +72,6 @@ in the system)::
bitmaskctl logs send
......@@ -110,6 +108,11 @@ virtualenv.
The various ``make dev-*`` commands will run the appropriate ``pip install``
commands for you.
If you want to setup your whole development environment, and you are running a
debian-based system, you can try::
make dev-bootstrap
Run headless backend in development mode
......@@ -38,6 +38,23 @@ parent folder.
Setting up the development environment
Automated procedure
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
environment with::
make dev-bootstrap
.. note:: the bootstrap script is, at the moment, quite opinionated. for
instance, it checks out the bitmask-dev repo under ~/leap folder, and
it assumes you are using zsh. if you think it should allow more
freedom of choices, feel free to open a pull request.
Manual procedure
Install the system-wide dependencies. For debian-based systems::
sudo apt install build-essential python-dev python-virtualenv \
......@@ -5,7 +5,7 @@
set -e
APT_DEPS="build-essential python-dev python-virtualenv libsqlcipher-dev libssl1.0-dev libffi-dev python-pyqt5 python-pyqt5.qtwebkit"
APT_DEPS="build-essential python-dev python-virtualenv libsqlcipher-dev libssl1.0-dev libffi-dev haveged python-pyqt5 python-pyqt5.qtwebkit"
function add_pew_to_environment()
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment