From: Huck Boles Date: Thu, 18 May 2023 18:53:25 +0000 (-0500) Subject: edit: readme updates X-Git-Url: https://git.huck.website/?a=commitdiff_plain;h=refs%2Fheads%2Fmain;p=odot.git edit: readme updates --- diff --git a/README b/README index db05547..1027040 100644 --- a/README +++ b/README @@ -1,57 +1,41 @@ - odot v0.3.0 - - Task manager written in C - - Installation: - - Download source files - $ curl "https://download.huck.website/odot-[VERSION].tar.gz" > odot.tar.gz - - Unpack source files - $ tar -xzvf odot.tar.gz - $ cd odot - - Build odot - $ make && sudo make install - - Usage: - - Results are modified by options preceded by a dash. - The rest of the line is parsed into a task. - - Available flags: - -g [group] Specify group for task - -n Add new task - -x Mark task as done - -s Show tasks - -a Show all groups - -d Also show completed tasks - -A Show all tasks in database - -r Remove task from database - -V Display version - -c Remove color - - Examples: - - Add a task to default group: + # odot v0.3.0 + +command line task manager + +## build odot: + $ make && sudo make install + +## available flags: + -g [group] specify group for task + -n add new task + -x mark task as done + -s show tasks + -a show all groups + -d also show completed tasks + -a show all tasks in database + -r remove task from database + -v display version + -c remove color + + examples: + + add a task to default group: $ odot -n "task" - - Show tasks in default group: + + show tasks in default group: $ odot - - Add a task to a group called newgroup: + + add a task to a group called newgroup: $ odot -ng newgroup "things to do" - - Finish a task and show other completed tasks: - $ odot -x "thing I did" -d - - Show all completed tasks in a group called tasks: + + finish a task and show other completed tasks: + $ odot -x "thing i did" -d + + show all completed tasks in a group called tasks: $ odot -dg tasks - - Show all tasks in database: - $ odot -A - - Remove a task from database (completely removes task from memory, useful for typos): - $ odot -r "task I want to forget" - + show all tasks in database: + $ odot -a + + remove a task from database (completely removes task from memory, useful for typos): + $ odot -r "task i want to forget"