From cbb86f13226c1008caf0e6ca531e0751c884006c Mon Sep 17 00:00:00 2001 From: Julio Capote Date: Sun, 21 Aug 2022 15:59:42 -0400 Subject: fix global cmd --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b45d572..73e7cb0 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ personal productivity system backed by [recfiles](https://en.wikipedia.org/wiki/ # dependencies -* [recutils](https://www.gnu.org/software/recutils/) -* uuidgen -* any perl +* [recutils](https://www.gnu.org/software/recutils/) (`brew install recutils`) +* uuidgen (included with most systems) +* any perl (included with most systems) # workflows @@ -20,6 +20,28 @@ You can use `recit` to track things like: # usage + Usage: recit [] + + Some useful recit commands are: + add-entry Add entries, optionally for a project and/or a certain time + add-project Add Project + commands List all recit commands + edit Open DB in $EDITOR + edit-entry Edit an entry given its UUID + entries Display entries, optionally for a project and/or a certain time + projects List all Projects + setup sets up a new recit database at $HOME/.recit.rec + today Show all entries for today + tomorrow Show all entries for tomorrow + + See 'recit help ' for information on a specific command. + +# installation + +download the latest releas (or clone the repository) and follow the instructions displayed when running `bin/recit init`. + +# getting started + `recit setup` gets you started ## add some entries -- cgit v1.2.3