diff options
Diffstat (limited to '')
-rw-r--r-- | README.md | 28 |
1 files changed, 25 insertions, 3 deletions
@@ -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 <command> [<args>] + + 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 <command>' 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 |