tildetown
/
rodo
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

main
m455 2019-03-12 23:43:15 -04:00
parent 9e216b72a5
commit 3189e7863c
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -123,13 +123,15 @@ For example: If you downloaded the project to your `~/downloads/` folder you wou
Type `rodo` plus one of the commands below with a space Type `rodo` plus one of the commands below with a space
between `rodo` and the command. between `rodo` and the command.
`init` - Initializes a file called `todo.txt` in `~/.rodo/` by default `-h` or `--help` - Displays the help message
`init` - Creates a file called `todo.txt` in `~/.rodo/` by default
**Note: The directory and filename can be changed by modifying the `config.rkt` file** **Note: The directory and filename can be changed by modifying the `config.rkt` file**
`ls` - Displays items from the todo list in a vertical format `ls` - Displays numbered items in the todo list
`add` - Adds an entry to the todo list `add` - Adds an item to the todo list
`rm` - Removes an item from the todo list `rm` - Removes an item from the todo list
@ -139,16 +141,22 @@ between `rodo` and the command.
The examples below assume that you have `rodo` [set up in your `$PATH`](https://github.com/m455/rodo#set-up-a-path) in your `$PATH` The examples below assume that you have `rodo` [set up in your `$PATH`](https://github.com/m455/rodo#set-up-a-path) in your `$PATH`
`rodo -h`
`rodo --help`
`rodo init` `rodo init`
`rodo ls` `rodo ls`
`rodo add "go to the park"` `rodo add "this is a task"`
`rodo add this is a task without quotes` `rodo add this is a task without quotes`
`rodo rm 1` `rodo rm 1`
**Note: You may have to run `rodo ls` to see which number corresponds to which item when removing items.**
# Configuring `rodo` # Configuring `rodo`
**Caution: Change the `config.rkt` file at your own risk, as it may break things!** **Caution: Change the `config.rkt` file at your own risk, as it may break things!**