Mercurial > getan
comparison README @ 438:d56fee6fd7ca
Documentation: Adds description of the available tree mode.
| author | Bernhard Reiter <bernhard@intevation.de> |
|---|---|
| date | Tue, 12 Sep 2017 14:52:30 +0200 |
| parents | 8b1916aabe65 |
| children | 3103429ec963 |
comparison
equal
deleted
inserted
replaced
| 437:70063d348739 | 438:d56fee6fd7ca |
|---|---|
| 4 Call ``getan`` or ``getan.py`` in a terminal to start | 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. | 5 with an empty list of tasks that you want to track time for. |
| 6 | 6 |
| 7 Use the Insert-Key to add a new task to track. | 7 Use the Insert-Key to add a new task to track. |
| 8 (A *task* is called *project* within getan.) | 8 (A *task* is called *project* within getan.) |
| 9 You will have to enter a project "key" and a project "description". | |
| 9 | 10 |
| 10 Now select one of the projects with the arrow keys from your keyboard | 11 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 and press enter to start the clock. See ``INTRODUCTION`` for more keyboard |
| 12 commands. | 13 commands. |
| 13 | 14 |
| 14 The time log entries will be saved in an sqlite database, | 15 The time log entries will be saved in an sqlite database, |
| 15 by default getan will create ``~/.getan/time.db``. | 16 by default getan will create ``~/.getan/time.db``. |
| 16 The ``scripts/`` will help to generate reports from them. | 17 The ``scripts/`` will help to generate reports from them. |
| 18 | |
| 19 Tree mode | |
| 20 --------- | |
| 21 Getan supports a hierarchy of projects. A top level project key | |
| 22 has only one character, once you starting using a second character | |
| 23 as project key, it will be the next level down in the hierarchy. | |
| 24 Example:: | |
| 25 | |
| 26 a Top level project | |
| 27 aa 1st second level project | |
| 28 ab 2nd second level project | |
| 29 aba Third level Project | |
| 30 | |
| 31 Use the switch_project_order key which is ``f2`` by default | |
| 32 to cycle to the hierarchical view. | |
| 33 | |
| 17 | 34 |
| 18 Customization | 35 Customization |
| 19 ------------- | 36 ------------- |
| 20 | 37 |
| 21 Use ``~/.getan/getanrc`` or the system-wide ``/etc/getanrc`` | 38 Use ``~/.getan/getanrc`` or the system-wide ``/etc/getanrc`` |