Mercurial > getan
changeset 288:1c9c3c9454e3
Update README
Use rst format for README
author | Björn Ricks <bjoern.ricks@intevation.de> |
---|---|
date | Fri, 10 May 2013 10:48:24 +0200 |
parents | dc251bfba30c |
children | 295cbbb42de4 |
files | README |
diffstat | 1 files changed, 89 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/README Fri May 10 10:04:05 2013 +0200 +++ b/README Fri May 10 10:48:24 2013 +0200 @@ -1,22 +1,100 @@ -1 - install urwid - - NOTE: getan requires urwid >= 1.0 +Installation +============ - On Debian GNU/Linux >= Wheezy just do: +Getan requires `urwid <http://excess.org/urwid>`_ in a version >= 1.0. Urwid is +a console user interface library written is python. - # apt-get install python-urwid +Install urwid +------------- -2 - starting getan: +On Debian GNU/Linux >= Wheezy just run as root::: + + $ apt-get install python-urwid + +On other systems urwid may be installed via pip or directly put into the sources +of getan. + +Using pip +^^^^^^^^^ + +To install urwid via pip run as root:: + + $ pip install urwid + +Or if you prefer using a virtualenv:: + + $ virtuelenv getan-env + $ source getan-env/bin/activate + (getan-env)$ pip install urwid + +Using urwid sources +^^^^^^^^^^^^^^^^^^^ + +Urwid can be put as source to the getan directory when getan is run directly +from the sources. Urwid source can be downloaded from `pypi +<https://pypi.python.org/pypi/urwid/>`_ or from the `urwid website +<http://excess.org/urwid/>`_. + +For urwid 1.1.1 the direct download link from pypi is +`<https://pypi.python.org/packages/source/u/urwid/urwid-1.1.1.tar.gz>`_ (md5sum +should be 932d199de6fc847eab2c151512220665).:: + + $ cd getan-source + $ wget https://pypi.python.org/packages/source/u/urwid/urwid-1.1.1.tar.gz + $ md5sum urwid-1.1.1.tar.gz + $ tar xzvf urwid-1.1.1.tar.gz + +Install getan +------------- + +A installation of getan is not required. It can also be run directly from the +sources. To install getan system wide the following command must be run as root +user:: + + $ python setup.py install + +Starting getan +============== + +Getan can be directly run from sources or after a system wide installation from +the bin dir (e.g. /usr/bin). + +Running from Sources +-------------------- + +To run getan from the sources run:: $ ./getan.py - or +or:: - $ ./getan.py mytime.db + $ ./getan.py /path/to/mytime.db - or (for the classic version of 'getan' based on curses): +to choose a different sqlite3 database the the defautl time.db + +The classic version of 'getan' which is based on curses can be run with:: + $ classic/getan - or +or:: - $ classic/getan mytime.db + $ classic/getan /path/to/mytime.db + +Running from installation +------------------------- + +After installing getan it can be run with:: + + $ getan + +or:: + + $ getan /path/to/mytime.db + +The classic version of 'getan' is also available:: + + $ getan-classic + +or:: + + $ getan-classic /path/to/mytime.db