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

updated READEME.md

main
m455 2018-05-19 22:17:25 -04:00
parent b62b8d18fb
commit 99dfbc317d
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -44,23 +44,28 @@ to
## Usage ## Usage
The below examples assume that you have rodo set up in your
$PATH folder. If you don't, you would simply go to the
directory of the `rodo.rkt` file and use `./rodo <command>`
instead.
### `init` ### `init`
Initializes a file in *~/.rodo/todo-list* Initializes a file in `~/.rodo/todo-list` by default
**Example:** `$ rodo init` **Example:** `rodo init`
### `ls` ### `ls`
Lists items from the list Lists items from the list
**Example:** `$ rodo rm 1` **Example:** `rodo rm 1`
### `add` ### `add`
Adds an item to the list Adds an item to the list
**Example:** `$ rodo add bread` **Example:** `rodo add bread`
**Note:** For multi-word items you will need to surround your item in double quotes like this: **Note:** For multi-word items you will need to surround your item in double quotes like this:
`$ rodo add "go to the bank"` `$ rodo add "go to the bank"`
@ -69,10 +74,10 @@ Adds an item to the list
Removes an item from the list Removes an item from the list
**Example:** `$ rodo rm 1` **Example:** `rodo rm 1`
**Note:** You may have to run `rodo ls` to see which number corresponds to which item to remove it. **Note:** You may have to run `rodo ls` to see which number corresponds to which item to remove it.
## Configure rodo ## Configuring rodo
Right now, the configurations can be found in the `config.rkt` file. Settings such at program name, path, and directory can be set here. Right now, the configurations can be found in the `config.rkt` file. Settings such at program name, path, and directory can be set here.