Mercurial > getan
comparison README @ 417:d6d9d319bd2e
Prepares for PyPi publication.
| author | Bernhard Reiter <bernhard@intevation.de> |
|---|---|
| date | Wed, 03 May 2017 16:29:24 +0200 |
| parents | 69ef6f89e930 |
| children | cd990c7dc746 |
comparison
equal
deleted
inserted
replaced
| 416:857d76de4a2f | 417:d6d9d319bd2e |
|---|---|
| 1 Usage | |
| 2 ===== | |
| 3 | |
| 4 Call ``getan`` or ``getan.py`` in a terminal to start | |
| 5 with an empty list of tasks that you want to track time for. | |
| 6 | |
| 7 Use the Insert-Key to add a new task to track. | |
| 8 (A *task* is called *project* within getan.) | |
| 9 | |
| 10 Now select one of the projects with the arrow keys from your keyboard | |
| 11 and press enter to start the clock. See ``INTRODUCTION`` for more keyboard | |
| 12 commands. | |
| 13 | |
| 14 The time log entries will be saved in an sqlite database. | |
| 15 The ``scripts/`` will help to generate reports from them. | |
| 16 | |
| 1 Installation | 17 Installation |
| 2 ============ | 18 ============ |
| 3 | 19 |
| 4 Getan requires `urwid <http://urwid.org/>`_ in a version >= 1.0. Urwid is | 20 Getan requires `urwid <http://urwid.org/>`_ in a version >= 1.0. Urwid is |
| 5 a console user interface library written in Python. For console output e.g. | 21 a console user interface library written in Python. For console output e.g. |
| 123 | 139 |
| 124 or:: | 140 or:: |
| 125 | 141 |
| 126 $ getan-classic /path/to/mytime.db | 142 $ getan-classic /path/to/mytime.db |
| 127 | 143 |
| 128 # vim: set ts=4 sw=4 tw=80 filetype=rst : | 144 .. vim: set ts=4 sw=4 tw=80 filetype=rst : |