From 377f5016bcc12a7678b2b31e9586f30614edd838 Mon Sep 17 00:00:00 2001 From: Patrick Lipka Date: Fri, 17 Dec 2021 13:50:36 +0100 Subject: [PATCH] Usage section added --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 80e0741..f02b6f4 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,29 @@ The file `$PREFIX/etc/tt.conf` has the format `key=value` and contains the follo * `tracking_directory` - directory where tracking files are saved and loaded from ## Usage +The program `tt` does not take any command line arguments. Once launched, it provides a command prompt which supports TAB completion and a command history using the arrow keys. It can be exited by pressing CTRL-C (catches SIGINT). + +At startup, the config file `$PREFIX/etc/tt.conf` is beeing read and tracking data is loaded from `tracking_directory` if available. In case there is no tracking data available for the current month, the project structures are loaded from the previous month's file. In case there is no data available, an empty project list is beeing set up. + +The following commands are available: +### 'ls []' + +### `np ` + +### `nt [/]` + +### `rm [/]` + +### `re [/]` + +### `sp ` + +### `st [/]` + +### `start /]` + +### `at [/]` + +### `rt [/]` + +### `report []`