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

updated README.md to be a little more useful

Browse Source
This commit is contained in:
m455 2018-04-18 00:12:32 -04:00
parent 91c8def7e9
commit 0a128707db
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,4 +1,5 @@
# rodo
A command-line todo list in Racket
***Current bugs:***
@ -10,33 +11,34 @@ A command-line todo list in Racket
## Commands
### `init`
Initializes a file in *~/.rodo/todo-list*
**Example:** `$ rodo init`
### `ls`
Lists items from the list
**Example:** `$ rodo rm 1`
### `add`
Adds an item to the list
**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"`
### `rm`
Removes an item from the list
**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
Right now, the configurations can be found in the `config.rkt` file. Settings such at program name, path, and directory can be set here.