diff options
| -rw-r--r-- | docs/checklist_for_leap_client_release.wiki | 9 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/user/install.rst | 45 |
3 files changed, 39 insertions, 19 deletions
diff --git a/docs/checklist_for_leap_client_release.wiki b/docs/checklist_for_leap_client_release.wiki index c61b258c..1340d684 100644 --- a/docs/checklist_for_leap_client_release.wiki +++ b/docs/checklist_for_leap_client_release.wiki @@ -1,18 +1,19 @@ = LEAP CLient Release Checklist (*) = - * [ ] validate rc - * [ ] all rc-critical closed! + * [.] validate rc + * [X] all rc-critical closed! * [ ] all bbots green * [ ] uploaded translations: make translations * [ ] re-generate pyqt resources * [ ] update docs + * [ ] check installation sections * [ ] CREDITS * [ ] relnotes.txt * [ ] docs/known_issues.rst * [ ] NEWS.rst: Add release name and date to top-most item in NEWS. - * [ ] change docs/quickstart.rst to point to just the current + * [ ] change docs/install.rst to point to just the current leap-client-X.Y.Z.deb binaries and .tar.gz source code files * [ ] on release/vX.Y.Z branch: git pull * [ ] git tag X.Y.Z @@ -45,4 +46,4 @@ notes ----- -(*) this checklist kindly borrowed from tahoe-lafs documentation =) +(*) the original version of this handy checklist kindly borrowed from tahoe-lafs documentation =) diff --git a/docs/conf.py b/docs/conf.py index 05c8cf5b..296cb262 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2012, The LEAP Encryption Access Project' # built documents. # # The short X.Y version. -version = '0.1.0' +version = '0.2.0' # The full version, including alpha/beta/rc tags. -release = '0.1.0' +release = '0.2.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/user/install.rst b/docs/user/install.rst index 1f0fd831..a52c1b87 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -9,32 +9,51 @@ We assume that you want to get it properly installed before being able to use it Debian package -------------- -.. warning:: +If you are lucky enough to be using a debian system... well, you are lucky enough :) - No updated debian package yet. +To be able to install ``leap-client``, you need to add the leap repo to your software sources. First you add the leap keys to your keyring:: -Once we have a release candidate, probably the easiest way of having the LEAP Client installed will be to install a .deb package under debian or ubuntu systems. + gpg --recv-key 0x1E34A1828E207901 0x485B12FA218E81EB + gpg -a --export 0x1E34A1828E207901 | sudo apt-key add - + +Now you edit :file:`/etc/apt/sources.list` and add the leap repository:: + + deb http://deb.leap.se/debian unstable main + +Get the package ``leap-keyring``, so you can install the packages in a trusted way and get key updates automatically:: + + apt-get update + apt-get install leap-keyring + +And, finally, install the client:: + + apt-get install leap-client Distribute & Pip ---------------- -.. warning:: +Install the dependencies:: + + apt-get install openvpn python-qt4 python-dev python-openssl + + +And then installing the client with `pip <http://www.pip-installer.org/>`_ is as simple as:: - This does not work yet, since we have not released an initial version yet to the cheese shop. + pip install leap-client -Installing LEAP Client will be as simple as using `pip <http://www.pip-installer.org/>`_ once we have a release candidate:: +Show me the code! +----------------- - $ pip install leap-client +You can get the latest tarball :: -Get the code ------------- + wget https://leap.se/downloads/leap-client/tarball/latest -.. warning:: +Or the zipball:: - This... won't work either, as-is. This should be the third optional way to install stable releases from master branch. Right now that does not work because there is *nothing* updated in the master branch. Leaving this here since this is what we will be doing, but if you really intend to have a working tree, refer to the sections :ref:`setting up a working environment <environment>` or :ref:`fetching latest code for testing <fetchinglatest>`. + wget http://leap.se/downloads/leap-client/zipball/latest -You can get the code from LEAP public git repository :: +Or, if you prefer, you can also get the code from LEAP public git repository :: git clone git://leap.se/leap_client @@ -42,6 +61,6 @@ Or from the github mirror :: git clone git://github.com/leapcode/leap_client.git -Once you have grabbed a copy of the sources, you can install it into your site-packages easily :: +Once you have grabbed a copy of the sources for whatever mean, you can install it into your site-packages:: $ pyton setup.py install |