diff options
Diffstat (limited to 'docs/dev/quickstart.rst')
| -rw-r--r-- | docs/dev/quickstart.rst | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index 978dc9e5..8ef7dfb8 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -13,6 +13,9 @@ to build the latest development code for ``bitmask_client`` the latest development branch for bitmask client, getting the GUI in debug mode and connect to a LEAP provider (bitmask.net) +If you want to know what each step is for, check +:ref:`this other section <environment>`. + Prerequisites ------------- @@ -36,8 +39,8 @@ Prerequisites Clone the repo into your working directory, and checkout development branch:: - $ git clone https://github.com/leapcode/bitmask_client - $ cd bitmask_client + $ git clone https://github.com/leapcode/bitmask_client bitmask + $ cd bitmask $ git checkout develop @@ -45,30 +48,26 @@ Create and activate the virtualenv, and symlink to your gloabal PySide install:: $ virtualenv . $ source bin/activate - $ pkg/postmkvenv.sh + (bitmask)$ pkg/postmkvenv.sh Python libraries ---------------- -.. TODO Check! -- this step should not be needed. setup develop should do it for you. -Install python requirements:: - - $ pip install -r pkg/requirements.pip - -Install the bitmask package in development mode inside the virtualenv:: +Install the bitmask package in development mode inside the virtualenv. This will +also install the needed dependencies:: - $ python2 setup.py develop + (bitmask)$ python2 setup.py develop Compile the resource files:: - $ make resources + (bitmask)$ make resources Copy necessary files into system folders, with root privileges:: - $ sudo mkdir -p /etc/leap - $ sudo cp pkg/linux/resolv-update /etc/leap - $ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/ + (bitmask)$ sudo mkdir -p /etc/leap + (bitmask)$ sudo cp pkg/linux/resolv-update /etc/leap + (bitmask)$ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/ Running @@ -76,7 +75,7 @@ Running Run ``bitmask_client`` in debug mode:: - $ bitmask --debug + (bitmask)$ bitmask --debug You should see the ``bitmask_client`` window prompting to connect to an existing node or add a new one. If not, something went wrong, maybe ask |