From 3f993fdab0f028656e266735c450aaf7bbe710b9 Mon Sep 17 00:00:00 2001 From: Patrick Lipka Date: Fri, 17 Dec 2021 16:10:59 +0100 Subject: [PATCH] Added documentation for start command --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ecb58db..bb7b637 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,30 @@ tt> st Test_Project/Debugging Switched to task Test Project/Debugging ~~~ -#### `start /]` +#### `start /][]` +Starts tracking for the currently active task.\ +If the optional parameter `` is present, the task with name `` of project `` is set active and tracking starts. This also causes the active project to change to ``.\ +Tracking can be stopped by pressing `CTRL-C`. + +Examples: +~~~ +tt> start +Started tracking of task Test Project/Debugging at Fri Dec 17 16:07:43 2021 + +Press CTRL-C to stop tracking +^C +Time worked on project: 00:00:02 +Tracking data saved to file /home/patrick/track/2021-12 +~~~ +~~~ +start Project_2/Task_1 +Started tracking of task Project 2/Task 1 at Fri Dec 17 16:10:07 2021 + +Press CTRL-C to stop tracking +^C +Time worked on project: 00:00:06 +Tracking data saved to file /home/patrick/track/2021-12 +~~~ #### `at [/]`