summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.rst25
-rw-r--r--docs/dev/environment.rst11
-rw-r--r--docs/testers/howto.rst2
3 files changed, 19 insertions, 19 deletions
diff --git a/README.rst b/README.rst
index d8e055da..be47a125 100644
--- a/README.rst
+++ b/README.rst
@@ -7,13 +7,15 @@ The LEAP Encryption Access Project Client
Read the docs!
==============
-You can read the documentation online at `http://leap-client.readthedocs.org <http://http://leap-client.readthedocs.org/en/latest/>`_. If you prefer to build it locally, run::
+You can read the documentation online at `http://leap-client.readthedocs.org <http://leap-client.readthedocs.org/en/latest/>`_. If you prefer to build it locally, run::
$ cd docs
$ make html
Quick Start
-=============
+==============
+
+At the current development stage we still do not have any versioned release. Instead, you might want to have a look at the `testers guide<http://leap-client.readthedocs.org/en/latest/testers/howto.html>`_ for a quick howto on fetching and testing latest development code.
Dependencies
------------------
@@ -21,7 +23,7 @@ Dependencies
Leap client depends on these libraries:
* ``python 2.6`` or ``2.7``
-* ``qt4 libraries`` (see installing Qt section below)
+* ``qt4 libraries``
* ``libgnutls``
* ``openvpn``
@@ -55,15 +57,9 @@ Use pip to install the required python packages::
Installing
-----------
-After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:
-
-.. note::
- if you have installed previous versions before::
- python setup.py clean
-
-And finally, build and install leap-client::
+After getting the source and installing all the dependencies, proceed to install ``leap-client`` package::
- python setup.py install
+ $ python setup.py install
Running
@@ -71,14 +67,13 @@ Running
After a successful installation, there should be a launcher called ``leap-client`` somewhere in your path::
- % leap-client
+ $ leap-client
Hacking
=======
-.. note::
- link to Hackers Guide in documentation.
+See the `hackers guide<http://leap-client.readthedocs.org/en/latest/dev/environment.html>`_
The LEAP client git repository is available at::
@@ -118,7 +113,7 @@ which the first time should also install all of them in your virtualenv for you.
License
=======
-.. image:: docs/user/intro/gpl.*
+.. image:: https://raw.github.com/leapcode/leap_client/develop/docs/user/gpl.png
The LEAP Client is released under the terms of the `GNU GPL version 3`_ or later.
diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst
index 55696537..8561396e 100644
--- a/docs/dev/environment.rst
+++ b/docs/dev/environment.rst
@@ -1,7 +1,7 @@
.. _environment:
-Setting up a Work Environment
-==============================
+Setting up a development environment
+====================================
This document covers how to get an enviroment ready to contribute code to the LEAP Client.
@@ -24,6 +24,8 @@ Leap client depends on these libraries:
* `libgnutls`
* `openvpn`
+Debian
+^^^^^^
In debian-based systems::
$ apt-get install openvpn python-qt4 python-crypto python-gnutls
@@ -79,7 +81,8 @@ A second option if that does not work for you would be to install PyQt globally
$ apt-get install python-qt4
$ virtualenv --site-packages .
-Or, if you prefer, you can also download the official PyQt tarball and execute `configure.py` in the root folder of their distribution, which generates a `Makefile`::
+.. TODO add link to PyQt tar.gz
+Or, if you prefer, you can also download the official PyQt tarball and execute `configure.py` in the root folder of their distribution, which generates a ``Makefile``::
$ python configure.py
$ make && make install
@@ -99,7 +102,7 @@ The setup script tries to install the policy file when installing the client sys
If you *only* are running the client from inside a virtualenv, you will need to copy this file by hand::
- $ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/net.openvpn.gui.leap.policy
+ $ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/
Missing Authentication agent
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/testers/howto.rst b/docs/testers/howto.rst
index 6212ed72..8de4a1eb 100644
--- a/docs/testers/howto.rst
+++ b/docs/testers/howto.rst
@@ -149,4 +149,6 @@ Reporting bugs
There is a great text on the art of bug reporting, that can be found `online <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_.
+.. TODO add a line with ref. to running the client in debug mode...
+
We use the `LEAP Client Bug Tracker <https://leap.se/code/projects/eip-client>`_, although you can also use `Github issues <https://github.com/leapcode/leap_client/issues>`_.