diff options
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README.rst | 7 | ||||
| -rw-r--r-- | docs/hacking/index.rst | 17 | ||||
| -rwxr-xr-x | pkg/tools/bitmask-bootstrap.sh | 2 |
4 files changed, 26 insertions, 3 deletions
@@ -4,6 +4,9 @@ DIST_VERSION = dist/bitmask-$(NEXT_VERSION)/ include pkg/pyinst/build.mk include pkg/thirdparty/openvpn/build.mk +dev-bootstrap: + pkg/tools/bitmask-bootstrap.sh + dev-mail: pip install -e '.[mail]' @@ -72,8 +72,6 @@ in the system):: bitmaskctl logs send - - Development =========================================================== @@ -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 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst index 8bff694c..20a55d5d 100644 --- a/docs/hacking/index.rst +++ b/docs/hacking/index.rst @@ -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 \ diff --git a/pkg/tools/bitmask-bootstrap.sh b/pkg/tools/bitmask-bootstrap.sh index 513b649a..0a033e7e 100755 --- a/pkg/tools/bitmask-bootstrap.sh +++ b/pkg/tools/bitmask-bootstrap.sh @@ -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() { |