From 4940c939ad7a5b0c0671c015c5967bfde8808d04 Mon Sep 17 00:00:00 2001 From: Jesse Laprade Date: Sun, 29 Jul 2018 09:55:23 -0400 Subject: [PATCH 1/5] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a767688..3a47eaf 100755 --- a/README.md +++ b/README.md @@ -14,15 +14,15 @@ project for use on your local machine ### Setting up rodo -1. Download from your terminal by running: +Download from your terminal 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: `echo "export PATH=~/bin:$PATH" >> .bashrc` -3. Create a file called `rodo` in your $PATH and add the +Create a file called `rodo` in your $PATH and add the following contents to it: ``` @@ -38,7 +38,7 @@ to `racket ~/downloads/rodo/rodo.rkt "$@"` -4. Make the `rodo` file executable: +Make the `rodo` file executable: `chmod u+x rodo` From 2456eaf36d39edcc17518663d46d4ffd3d7090c4 Mon Sep 17 00:00:00 2001 From: Jesse Laprade Date: Sun, 29 Jul 2018 21:27:21 -0400 Subject: [PATCH 2/5] Update README.md --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3a47eaf..9483bb7 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 -Download from your terminal by running: +Download rodo by running: `git clone https://github.com/m455/rodo` -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` -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: ``` From 9a00f4eaa5b2da5c6c12aa9bfd3e19e28d5610a4 Mon Sep 17 00:00:00 2001 From: Jesse Laprade Date: Mon, 30 Jul 2018 14:57:00 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9483bb7..dc750e1 100755 --- a/README.md +++ b/README.md @@ -48,19 +48,19 @@ $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` -### `ls` +### ls Lists items from the list **Example:** `rodo rm 1` -### `add` +### add Adds an item to the list @@ -69,7 +69,7 @@ Adds an item to the list **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 From a871151f182f0a95dde79ef32901d5e526a7fc3c Mon Sep 17 00:00:00 2001 From: Jesse Laprade Date: Mon, 30 Jul 2018 14:57:43 -0400 Subject: [PATCH 4/5] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dc750e1..264b346 100755 --- a/README.md +++ b/README.md @@ -52,19 +52,19 @@ instead. Initializes a file in `~/.rodo/todo-list` by default -**Example:** `rodo init` +Example: `rodo init` ### ls Lists items from the list - **Example:** `rodo rm 1` +Example: `rodo rm 1` ### 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"` @@ -73,7 +73,7 @@ Adds an item to 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. From 0bdb09d3b0805ff119cf43b24b4801e844a5b568 Mon Sep 17 00:00:00 2001 From: Jesse Laprade Date: Mon, 30 Jul 2018 14:59:02 -0400 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 264b346..f19ea8c 100755 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ Example: `rodo init` Lists items from the list -Example: `rodo rm 1` +Example: `rodo ls` ### add