From 297694e06ffb1eb4b191cbc164bd1d7a8ba5f46b Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 16 Oct 2013 16:39:13 -0300 Subject: Update apt-get dependencies * Also, tweak different sections to be consistent with the new quickstart. * Squashed contributions by Jeremy (@bneg) * add note about authors.rst --- docs/dev/quickstart.rst | 81 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 docs/dev/quickstart.rst (limited to 'docs/dev/quickstart.rst') diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst new file mode 100644 index 00000000..8f0e90dd --- /dev/null +++ b/docs/dev/quickstart.rst @@ -0,0 +1,81 @@ +Quickstart +========== + +**Assumptions:** These instructions were made on a clean Ubuntu 12.04.3 +system. + +**Goal:** With minimal effort or reading install the necessary packages +to build the latest development code for ``bitmask_client`` + +**Outcome:** At the end of these instructions, you should be able to run +the latest development branch for bitmask client, getting the GUI in debug +mode and connect to a LEAP provider (bitmask.net) + + +Prerequisites +------------- + +.. begin-debian-deps +:: + + $ sudo apt-get install git python-dev python-setuptools + python-virtualenv python-pip python-openssl libsqlite3-dev g++ openvpn + pyside-tools python-pyside + +.. python-qt4 ??? (for translations) +.. TODO I'm pretty sure python-qt4 shoudln't be there... + Nor libsqlite-dev, that's a bug in python-sqlcipher/soledad. + + +.. XXX any change HERE ^^^^ should be reflected also in README.rst. + From any other place in the documentation, it should be just included. + +.. end-debian-deps + +Clone the repo into your working directory, and checkout development branch:: + + $ git clone https://github.com/leapcode/bitmask_client + $ cd bitmask_client + $ git checkout develop + + +Create and activate the virtualenv, and symlink to your gloabal PySide install:: + + $ virtualenv . + $ source bin/activate + $ 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:: + + $ ./setup.py develop + +Compile the resource files:: + + $ make + +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/ + + +Running +-------- + +Run ``bitmask_client`` in debug mode:: + + $ 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 +on #leap-dev at irc.freenode.net -- cgit v1.2.3 From e1fee7f497c5b31e88600aa2d8702b9fef78951d Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 22 Oct 2013 10:49:40 -0200 Subject: Fixes to environment.rst. Closes: #4185 --- docs/dev/quickstart.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/dev/quickstart.rst') diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index 8f0e90dd..978dc9e5 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -1,3 +1,5 @@ +.. _quickstart: + Quickstart ========== @@ -56,11 +58,11 @@ Install python requirements:: Install the bitmask package in development mode inside the virtualenv:: - $ ./setup.py develop + $ python2 setup.py develop Compile the resource files:: - $ make + $ make resources Copy necessary files into system folders, with root privileges:: -- cgit v1.2.3 From 1e1e65134474d65c00a0b5ed89c70fe46c56a1e5 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 22 Oct 2013 11:09:12 -0200 Subject: add prompt indication for the virtualenv --- docs/dev/quickstart.rst | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) (limited to 'docs/dev/quickstart.rst') 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 `. + 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 -- cgit v1.2.3