From ebff18f9194cff3d1a8dd0f682475c38d62b55c8 Mon Sep 17 00:00:00 2001 From: Patrick Lipka Date: Fri, 17 Dec 2021 15:57:50 +0100 Subject: [PATCH] Added documentation for sp command --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f968514..ad0e861 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,8 @@ One task cannot be part of multiple projects. Tasks are not further divided into The following commands are available: #### `ls []` Prints active project, active task (if present) and the names of all projects.\ -If the optional parameter `` is present, a list of Tasks for this project is printed.\ +If the optional parameter `` is present, a list of Tasks for this project is printed. + Example: ~~~ tt> ls @@ -69,7 +70,8 @@ Time Tracker Development ~~~ #### `np ` -Creates a new empty project with the given name and sets it active. The name must be different from the existing projects.\ +Creates a new empty project with the given name and sets it active. The name must be different from the existing projects. + Example: ~~~ tt> np Test Project @@ -79,7 +81,8 @@ Switched to project Test Project #### `nt [/]` Creates a new task with the given name inside the currently active project and sets it active.\ If the optional parameter `` is present, the task si beeing created in the specified Project instead. This also changes the active project\ -The task name must be different from existing tasks.\ +The task name must be different from existing tasks. + Examples: ~~~ tt> nt Test Task @@ -94,7 +97,8 @@ Switched to task HPCE/test Deletes all data of a project or task.\ If only a project name is provided, the project with all tasks is beeing deleted. The previous project in the project list is set active\ If only a task name is provided, this task is beeing deleted from the active project if present. The previous task in the task list is set active.\ -If `/` is provided, the task with name `` is deleted from project `` if both are present.\ +If `/` is provided, the task with name `` is deleted from project `` if both are present. + Examples: ~~~ tt> rm test @@ -120,11 +124,12 @@ Switched to project HPCE Tracking data saved to file /home/patrick/track/2021-12 ~~~ -#### `re [/] | ` +#### `re [/] | ` Renames tasks or projects to the new name.\ If only a project name is provided, the project is beeing renamed. \ If only a task name is provided, this task inside the active project is renamed. \ -If `/` is provided, the task with name `` in Project `` is renamed.\ +If `/` is provided, the task with name `` in Project `` is renamed. + Examples: ~~~ tt> re Tets Test @@ -143,6 +148,13 @@ Tracking data saved to file /home/patrick/track/2021-12 ~~~ #### `sp ` +Switches to another project, thus setting Project with name `` active. + +Example: +~~~ +tt> sp Project 2 +Switched to project Project 2 +~~~ #### `st [/]`