summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIvan Alejandro <ivanalejandro0@gmail.com>2014-03-14 16:59:48 -0300
committerIvan Alejandro <ivanalejandro0@gmail.com>2014-03-14 17:18:28 -0300
commit0698a268c790e533430dadc398b0346dc6211619 (patch)
tree8182b7a5d508440154b137a293dce727b1f7c6df /docs
parent8adb717f7a75e1a7f1a5a285b6a806cc368e7549 (diff)
Add automagic helper script.
Diffstat (limited to 'docs')
-rw-r--r--docs/client/dev-environment.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/docs/client/dev-environment.md b/docs/client/dev-environment.md
index dc82f0b..402db6f 100644
--- a/docs/client/dev-environment.md
+++ b/docs/client/dev-environment.md
@@ -4,7 +4,7 @@
Setting up a development environment
====================================
-This document covers how to get an enviroment ready to contribute code
+This document covers how to get an environment ready to contribute code
to Bitmask.
Cloning the repo
@@ -79,7 +79,7 @@ your virtualenv:
$ virtualenv --site-packages .
After that, you must export `LEAP_VENV_SKIP_PYSIDE` to skip the
-isntallation:
+installation:
$ export LEAP_VENV_SKIP_PYSIDE=1
@@ -92,3 +92,21 @@ working environment, they will be installed avoiding the need for
administrative permissions:
$ pip install -r pkg/requirements.pip
+
+
+Using automagic helper script
+-----------------------------
+
+You can use a helper script that will get you started with bitmask and all the related repos.
+1) install system dependencies
+2) download automagic script
+3) run it :)
+
+Commands so you can copy/paste:
+
+ mkdir bitmask && cd bitmask
+ wget https://raw.githubusercontent.com/leapcode/bitmask_client/develop/pkg/scripts/bootstrap_develop.sh
+ chmod +x bootstrap_develop.sh
+ ./bootstrap_develop.sh init # use help parameter for more information
+
+This script allows you to get started, update and run the bitmask app with all its repositories.