diff --git a/README.md b/README.md index a767688..f19ea8c 100755 --- a/README.md +++ b/README.md @@ -1,11 +1,6 @@ # rodo -A command-line todo list written in Racket - -## Getting started - -The following instructions will get you a copy of the -project for use on your local machine +An easy-to-use todo list program for people who live on the command line written in Racket. ### Requirements @@ -14,15 +9,19 @@ project for use on your local machine ### Setting up rodo -1. Download from your terminal by running: +Download rodo by running: `git clone https://github.com/m455/rodo` -2. Create a $PATH if you haven't done so already: +Create a $PATH if you haven't done so already by running: -`echo "export PATH=~/bin:$PATH" >> .bashrc` +`echo "export PATH=~/bin:\$PATH" >> .bashrc` -3. Create a file called `rodo` in your $PATH and add the +Make the actual directory for your `$PATH`: + +`mkdir ~/bin/` + +Create a file called `rodo` in your $PATH (in your ~/bin/ folder if you followed the instructions above) and add the following contents to it: ``` @@ -38,7 +37,7 @@ to `racket ~/downloads/rodo/rodo.rkt "$@"` -4. Make the `rodo` file executable: +Make the `rodo` file executable: `chmod u+x rodo` @@ -49,32 +48,32 @@ $PATH folder. If you don't, you would simply go to the directory of the `rodo.rkt` file and use `./rodo ` instead. -### `init` +### init Initializes a file in `~/.rodo/todo-list` by default -**Example:** `rodo init` +Example: `rodo init` -### `ls` +### ls Lists items from the list - **Example:** `rodo rm 1` +Example: `rodo ls` -### `add` +### add 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: `$ rodo add "go to the bank"` -### `rm` +### rm 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.