9783079c45
Add some actual sphinx documentation. This is basically the README split up into sections. Once this is actually published somewhere, we can remove some of the content from the README and link to an on-line reference instead. Change-Id: I25e5ff842e94a5a05aa62c164952df93efc49e98
54 lines
989 B
ReStructuredText
54 lines
989 B
ReStructuredText
Installation
|
|
------------
|
|
|
|
Debian
|
|
~~~~~~
|
|
|
|
Gertty is packaged in Debian and is currently available in:
|
|
|
|
* unstable
|
|
* testing
|
|
* stable
|
|
|
|
You can install it with::
|
|
|
|
apt-get install gertty
|
|
|
|
Fedora
|
|
~~~~~~
|
|
|
|
Gertty is packaged starting in Fedora 21. You can install it with::
|
|
|
|
yum install python-gertty
|
|
|
|
openSUSE
|
|
~~~~~~~~
|
|
|
|
Gertty is packaged for openSUSE 13.1 onwards. You can install it via
|
|
`1-click install from the Open Build Service <http://software.opensuse.org/package/python-gertty>`_.
|
|
|
|
Arch Linux
|
|
~~~~~~~~~~
|
|
|
|
Gertty packages are available in the Arch User Repository packages. You
|
|
can get the package from::
|
|
|
|
https://aur.archlinux.org/packages/python2-gertty/
|
|
|
|
Source
|
|
~~~~~~
|
|
|
|
When installing from source, it is recommended (but not required) to
|
|
install Gertty in a virtualenv. To set one up::
|
|
|
|
virtualenv gertty-env
|
|
source gertty-env/bin/activate
|
|
|
|
To install the latest version from the cheeseshop::
|
|
|
|
pip install gertty
|
|
|
|
To install from a git checkout::
|
|
|
|
pip install .
|