diff options
author | kali <kali@leap.se> | 2012-12-19 07:45:02 +0900 |
---|---|---|
committer | kali <kali@leap.se> | 2012-12-19 07:45:02 +0900 |
commit | 5c0eb246d468454de9e84dca0d08c813459a5a6d (patch) | |
tree | ce9dc227600aeaa7b2a11035926ed2ff15560efd /docs/user/install.rst | |
parent | 20f779b644a551bf56cb735868c55cd50d7c3610 (diff) |
documentation update!
reSTructured (no pun intended) the sphinx docs,
and trimmed README
Diffstat (limited to 'docs/user/install.rst')
-rw-r--r-- | docs/user/install.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/user/install.rst b/docs/user/install.rst new file mode 100644 index 00000000..22f88b12 --- /dev/null +++ b/docs/user/install.rst @@ -0,0 +1,47 @@ +.. _install: + +Installation +============ + +This part of the documentation covers the installation of the LEAP Client. +We assume that you want to get it properly installed before being able to use it. + +Debian package +-------------- + +.. warning:: + + No updated debian package yet. + +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. + + +Distribute & Pip +---------------- + +.. warning:: + + This does not work yet, since we have not released an initial version yet to the cheese shop. + +Installing LEAP Client will be as simple as using `pip <http://www.pip-installer.org/>`_ once we have a release candidate:: + + $ pip install leap-client + +Get the code +------------ + +.. warning:: + + 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 <fetchinglatest>`. + +You can get the code from LEAP public git repository :: + + git clone git://leap.se/leap_client + +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 :: + + $ pyton setup.py install |