From 297694e06ffb1eb4b191cbc164bd1d7a8ba5f46b Mon Sep 17 00:00:00 2001
From: Kali Kaneko <kali@leap.se>
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