summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2017-07-25 14:42:56 -0400
committerKali Kaneko <kali@leap.se>2017-07-25 14:42:56 -0400
commitb71689d6fad298c3ccd0c8550ff71ad6f1c2cb40 (patch)
treed300e5189be981bafc20adf63f79ca6e10d814ae /docs
parent1175a0b3110d69f1d3105530dfc22ee17fb2eb21 (diff)
[docs] document the dev-bootstrap script0.10a2
Diffstat (limited to 'docs')
-rw-r--r--docs/hacking/index.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst
index 8bff694..20a55d5 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 \