Mercurial > getan
changeset 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 | 70063d348739 |
| children | 3103429ec963 |
| files | CHANGES INTRODUCTION README |
| diffstat | 3 files changed, 22 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/CHANGES Thu Sep 07 17:40:49 2017 +0200 +++ b/CHANGES Tue Sep 12 14:52:30 2017 +0200 @@ -2,6 +2,9 @@ TODO + * Documentation: Adds description of the available tree mode. + + 2.1 2017-09-07 * Adds option '--init-only' which will non-interactively just
--- a/INTRODUCTION Thu Sep 07 17:40:49 2017 +0200 +++ b/INTRODUCTION Tue Sep 12 14:52:30 2017 +0200 @@ -7,7 +7,8 @@ | tab | Switch focus between ProjectList and EntryList | enter | start/stop a project (in ProjectList), mark an entry (in EntryList). -| [project key] | Start the specified project. +| [project key] | Selects a project to run. Will start it, if the key + pressed is the last to uniquely identify a project. | space | Pause a running project (the time that will be inserted into database is the real running time without the break. | F1 | Switch time display mode in ProjectList.
--- a/README Thu Sep 07 17:40:49 2017 +0200 +++ b/README Tue Sep 12 14:52:30 2017 +0200 @@ -6,6 +6,7 @@ Use the Insert-Key to add a new task to track. (A *task* is called *project* within getan.) +You will have to enter a project "key" and a project "description". Now select one of the projects with the arrow keys from your keyboard and press enter to start the clock. See ``INTRODUCTION`` for more keyboard @@ -15,6 +16,22 @@ by default getan will create ``~/.getan/time.db``. The ``scripts/`` will help to generate reports from them. +Tree mode +--------- +Getan supports a hierarchy of projects. A top level project key +has only one character, once you starting using a second character +as project key, it will be the next level down in the hierarchy. +Example:: + + a Top level project + aa 1st second level project + ab 2nd second level project + aba Third level Project + +Use the switch_project_order key which is ``f2`` by default +to cycle to the hierarchical view. + + Customization -------------