From 907d97f4234c1fb6f3e6fb3f425206d5f8adadce Mon Sep 17 00:00:00 2001
From: m455 <jesselaprade@gmail.com>
Date: Tue, 11 Dec 2018 08:53:32 -0500
Subject: [PATCH] made readme more technical-writer worthy

---
 README.md | 93 +++++++++++++++++++++++++++++++------------------------
 1 file changed, 53 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index 72a7cac..0330474 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ A simple to-do list tool for people who live on the command-line
 
 By: Jesse Laprade
 =======
-A simple to-do list program for people who live on the command line
+A simple todo list program for people who live on the command line
 
 ![](screenshot.png)
 
@@ -17,81 +17,94 @@ A simple to-do list program for people who live on the command line
 * [Requirements](https://github.com/m455/rodo#requirements)
 * [Downloading](https://github.com/m455/rodo#downloading)
 * [Setup](https://github.com/m455/rodo#setup)
-    * [GNU/Linux](https://github.com/m455/rodo#gnulinux)
+    * [GNU/Linux and Windows Subsystem for Linux](https://github.com/m455/rodo#gnulinux-and-windows-subsystem-for-linux)
 * [Usage](https://github.com/m455/rodo#usage)
 * [Examples](https://github.com/m455/rodo#examples)
 * [Configuration](https://github.com/m455/rodo#configuring-rodo)
 
-## Platforms
+# Platforms
 
 * GNU/Linux
+* Windows Subsystem for Linux
 
 ## Requirements
 
 * [Racket 6.x](https://racket-lang.org/)
-* [Git (Optional)](https://git-scm.com/)
+* [Git](https://git-scm.com/)(Optional method for downloading)
 
-## Downloading
-
-* Via Browser
-    * Download this repository by clicking the **Clone or download** button at the top right, then choose **Download ZIP** from the drop-down list
+# Downloading
 
+* Via GitHub
+    1. Click the *Clone or download* button in the top right
+    2. Click *Download ZIP* from the drop-down list
 * Via Git
-    * Run `git clone https://github.com/m455/rodo` at the command line
+    * Run `git clone https://github.com/m455/rodo` on the command line
 
-## Setup
+# Setup
 
 The steps below will assist the user in setting up rodo
 
-### GNU/Linux
+## GNU/Linux and Windows Subsystem for Linux
 
-1. Setup a $PATH
-    1. Create a directory for your `$PATH` by running `mkdir ~/bin/`
-    2. Associate your `$PATH` with the ~/bin/ folder you created by running `echo "export PATH=~/bin:\$PATH" >> .bashrc`
+Follow the steps below to set up rodo
 
-2. Using the binary
-    1. Copy the rodo binary file to your `$PATH` folder by running `cp /path/to/rodo ~/bin/`
-    2. Make the rodo binary file executable by running `chmod u+x ~/bin/rodo`
+### Setup a $PATH
 
-3. Creating a wrapper
-    1. Create an empty wrapper file by running `touch ~/bin/rodo`.
-    2. Add the following contents show below to it
-    ```
-    #!/usr/bin/env bash
-    racket ~/path/to/rodo.rkt "$@"
-    ```
-    For example, if you downloaded the project to your ~/downloads/ folder you would change the line `racket ~/path/to/rodo.rkt "$@"` to `racket ~/downloads/rodo/rodo.rkt "$@"`
+1. Create a directory for your `$PATH` by running `mkdir ~/bin/`
+2. Add your newly-created `~/bin/` to your `$PATH` by running `echo "export PATH=~/bin:\$PATH" >> .bashrc`
 
-    3. Save the file
-    4. Make the rodo wrapper file executable by running`chmod u+x ~/bin/rodo`
+### Adding rodo to your $PATH
 
-## Usage
+1. Create a file in your `~/bin/` directory with the following contents in it:
 
-init - Initializes a file in ~/.rodo/todo-list by default
+```
+#!/usr/bin/env bash
+racket ~/path/to/rodo.rkt "$@"
+```
 
-ls - Lists items from the list
+For example, if you downloaded the project to your
+~/downloads/ folder you would change the line `racket
+~/path/to/rodo.rkt "$@"` to `racket
+~/downloads/rodo/rodo.rkt "$@"`.
 
-add - Adds an entry to the list
+If you prefer to use an executable, rather than a wrapper,
+you can create an executable binary file with `raco exe
+file-name-here.rkt`.
 
-rm - Removes an item from the list
+2. Save the file
+
+3. Make the file executable by running `chmod u+x ~/bin/name-of-your-file`
+
+# Usage
+
+Type `rodo` plus one of the options below with a space
+between `rodo` and the option.
+
+`init` - Initializes a file in ~/.rodo/todo-list by default
+
+`ls` - Lists items from the list
+
+`add` - Adds an entry to the list
+
+`rm` - Removes an item from the list
 
 **Note:** You may have to run `rodo ls` to see which number corresponds to which item when removing items.
 
-## Examples
+## Usage examples
 
 The examples below assume that you have rodo [set up](https://github.com/m455/rodo#setup-a-path) in your `$PATH`
 
-init - `rodo init`
+`rodo init`
 
-ls - `rodo ls`
+`rodo ls`
 
-add (Single-word entry) - `rodo add bread`
+`rodo add bread` (Single-word entry)
 
-add (Multi-word entry) - `rodo add "go to the bank"`
+`rodo add "go to the bank"` (Multi-word entry)
 
-rm - `rodo rm 1`
+`rodo rm 1`
 
-## Configuring 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 as program name, path, and directory can be changed.