made readme more technical-writer worthy

main
m455 2018-12-11 08:53:32 -05:00
parent 09da8dd9e4
commit 907d97f423
1 changed files with 53 additions and 40 deletions

View File

@ -7,7 +7,7 @@ A simple to-do list tool for people who live on the command-line
By: Jesse Laprade 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) ![](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) * [Requirements](https://github.com/m455/rodo#requirements)
* [Downloading](https://github.com/m455/rodo#downloading) * [Downloading](https://github.com/m455/rodo#downloading)
* [Setup](https://github.com/m455/rodo#setup) * [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) * [Usage](https://github.com/m455/rodo#usage)
* [Examples](https://github.com/m455/rodo#examples) * [Examples](https://github.com/m455/rodo#examples)
* [Configuration](https://github.com/m455/rodo#configuring-rodo) * [Configuration](https://github.com/m455/rodo#configuring-rodo)
## Platforms # Platforms
* GNU/Linux * GNU/Linux
* Windows Subsystem for Linux
## Requirements ## Requirements
* [Racket 6.x](https://racket-lang.org/) * [Racket 6.x](https://racket-lang.org/)
* [Git (Optional)](https://git-scm.com/) * [Git](https://git-scm.com/)(Optional method for downloading)
## 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
* Via GitHub
1. Click the *Clone or download* button in the top right
2. Click *Download ZIP* from the drop-down list
* Via Git * 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 The steps below will assist the user in setting up rodo
### GNU/Linux ## GNU/Linux and Windows Subsystem for Linux
1. Setup a $PATH Follow the steps below to set up rodo
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`
2. Using the binary ### Setup a $PATH
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`
3. Creating a wrapper 1. Create a directory for your `$PATH` by running `mkdir ~/bin/`
1. Create an empty wrapper file by running `touch ~/bin/rodo`. 2. Add your newly-created `~/bin/` to your `$PATH` by running `echo "export PATH=~/bin:\$PATH" >> .bashrc`
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 "$@"`
3. Save the file ### Adding rodo to your $PATH
4. Make the rodo wrapper file executable by running`chmod u+x ~/bin/rodo`
## 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. **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` 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.