patrick
/
tt
mirror of https://github.com/PatrickLipka/tt.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Usage section added

This commit is contained in:
Patrick Lipka 2021-12-17 13:50:36 +01:00
parent 1d4ffa73e5
commit 377f5016bc
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -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 [<Project Name>]'
### `np <Project Name>`
### `nt [<Project Name>/]<Task Name>`
### `rm [<Project Name>/]<Task Name>`
### `re [<Project Name>/]<Task Name>`
### `sp <Project Name>`
### `st [<Project Name>/]<Task Name>`
### `start <Project Name>/]<Task Name>`
### `at [<Project Name>/]<Task Name>`
### `rt [<Project Name>/]<Task Name>`
### `report [<yyyy-mm>]`