updated READEME.md
parent
fb245b1b8f
commit
6c42714fb7
47
README.md
47
README.md
|
@ -1,22 +1,57 @@
|
|||
# rodo
|
||||
|
||||
A command-line todo list in Racket
|
||||
**rodo** is a command-line todo list written in Racket
|
||||
|
||||
## Commands
|
||||
## Getting started
|
||||
|
||||
### `init`
|
||||
The following instructions will get you a copy of the
|
||||
project for use on your local machine
|
||||
|
||||
### Requirements
|
||||
|
||||
* GNU/Linux
|
||||
* Racket 6.x
|
||||
|
||||
## Setting up rodo
|
||||
|
||||
1. Download from your terminal by running:
|
||||
|
||||
`git clone https://github.com/m455/rodo`
|
||||
|
||||
2. 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:
|
||||
|
||||
```
|
||||
#!/usr/bin/env bash
|
||||
racket ~/path/to/rodo.rkt "$@"
|
||||
```
|
||||
(For example, if you `git clone`d the project to your
|
||||
`~/downloads/` folder you would change `racket
|
||||
~/path/to/rodo.rkt "$@"` to 'racket
|
||||
~/downloads/rodo/rodo.rkt "$@"`)
|
||||
|
||||
4. Make the `rodo` file executable:
|
||||
|
||||
`chmod u+x rodo`
|
||||
|
||||
### Usage
|
||||
|
||||
## `init`
|
||||
|
||||
Initializes a file in *~/.rodo/todo-list*
|
||||
|
||||
**Example:** `$ rodo init`
|
||||
|
||||
### `ls`
|
||||
## `ls`
|
||||
|
||||
Lists items from the list
|
||||
|
||||
**Example:** `$ rodo rm 1`
|
||||
|
||||
### `add`
|
||||
## `add`
|
||||
|
||||
Adds an item to the list
|
||||
|
||||
|
@ -25,7 +60,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
|
||||
|
||||
|
|
Loading…
Reference in New Issue