rodo/README.md

84 lines
1.6 KiB
Markdown
Raw Normal View History

2018-03-12 14:00:41 +00:00
# rodo
2018-05-29 03:31:55 +00:00
**rodo** - A command-line todo list written in Racket
2018-03-12 14:01:22 +00:00
2018-05-20 02:03:00 +00:00
## Getting started
2018-04-10 00:27:01 +00:00
2018-05-20 02:03:00 +00:00
The following instructions will get you a copy of the
project for use on your local machine
### Requirements
* GNU/Linux
* Racket 6.x
2018-05-20 02:09:18 +00:00
### Setting up rodo
2018-05-20 02:03:00 +00:00
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`
2018-05-20 02:04:18 +00:00
3. Create a file called `rodo` in your $PATH and add the
following contents to it:
2018-05-20 02:03:00 +00:00
```
#!/usr/bin/env bash
racket ~/path/to/rodo.rkt "$@"
```
2018-05-20 02:05:34 +00:00
For example, if you `git clone`d the project to your
`~/downloads/` folder you would change the line:
`racket ~/path/to/rodo.rkt "$@"`
to
2018-05-20 02:06:07 +00:00
`racket ~/downloads/rodo/rodo.rkt "$@"`
2018-05-20 02:03:00 +00:00
4. Make the `rodo` file executable:
`chmod u+x rodo`
2018-05-20 02:09:18 +00:00
## Usage
2018-05-20 02:03:00 +00:00
2018-05-20 02:17:25 +00:00
The below examples assume that you have rodo set up in your
$PATH folder. If you don't, you would simply go to the
directory of the `rodo.rkt` file and use `./rodo <command>`
instead.
2018-05-20 02:09:18 +00:00
### `init`
2018-05-20 02:17:25 +00:00
Initializes a file in `~/.rodo/todo-list` by default
2018-05-20 02:17:25 +00:00
**Example:** `rodo init`
2018-04-10 00:27:01 +00:00
2018-05-20 02:09:18 +00:00
### `ls`
Lists items from the list
2018-05-20 02:17:25 +00:00
**Example:** `rodo rm 1`
2018-04-13 06:14:51 +00:00
2018-05-20 02:09:18 +00:00
### `add`
Adds an item to the list
2018-04-13 06:14:51 +00:00
2018-05-20 02:17:25 +00:00
**Example:** `rodo add bread`
2018-04-17 03:05:18 +00:00
**Note:** For multi-word items you will need to surround your item in double quotes like this:
`$ rodo add "go to the bank"`
2018-04-10 00:27:01 +00:00
2018-05-20 02:09:18 +00:00
### `rm`
Removes an item from the list
2018-04-13 06:14:51 +00:00
2018-05-20 02:17:25 +00:00
**Example:** `rodo rm 1`
2018-04-13 06:14:51 +00:00
**Note:** You may have to run `rodo ls` to see which number corresponds to which item to remove it.
2018-05-20 02:17:25 +00:00
## 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.