rodo/README.md

95 lines
2.4 KiB
Markdown
Raw Normal View History

2018-03-12 14:00:41 +00:00
# rodo
2018-09-08 01:02:24 +00:00
An easy-to-use todo list program for people who live on the command line written in Racket
2018-05-20 02:03:00 +00:00
2018-09-08 01:01:00 +00:00
## Platforms
2018-05-20 02:03:00 +00:00
* GNU/Linux
2018-09-08 01:01:00 +00:00
* Microsoft Windows
* OS X
## Requirements
2018-05-20 02:03:00 +00:00
* Racket 6.x
2018-09-08 01:01:00 +00:00
* Git (Optional)
## Download
2018-05-20 02:03:00 +00:00
2018-09-08 01:03:08 +00:00
### Via Git
2018-09-08 01:02:24 +00:00
Download this repository by clicking the `Clone or download` button at the top right and then by clicking `Download ZIP` from the drop-down list
2018-05-20 02:03:00 +00:00
2018-09-08 01:03:08 +00:00
### Via Github
2018-09-08 01:01:00 +00:00
Run `git clone https://github.com/m455/rodo` at the command line if you use Git
2018-09-08 01:01:00 +00:00
## Setting up rodo
### GNU/Linux
#### Using the executable binary
2018-09-08 01:11:59 +00:00
Create a $PATH if you haven't done so already by running `echo "export PATH=~/bin:\$PATH" >> .bashrc`
2018-09-08 01:11:59 +00:00
Make the actual directory for your **$PATH** by running `mkdir ~/bin/`
2018-09-08 01:11:59 +00:00
Add the **rodo** binary to your **$PATH** folder (in your **~/bin/** folder if you followed the instructions above) and make sure it's executable by running `chmod u+x ~/bin/rodo`
2018-09-08 01:01:00 +00:00
#### Using and creating a wrapper
2018-05-20 02:03:00 +00:00
2018-09-08 01:11:59 +00:00
Create a file called **rodo** in your **$PATH** folder (in your ~/bin/ folder if you followed the instructions above) by running `touch ~/bin/rodo` and then add the following contents to it:
2018-05-20 02:03:00 +00:00
```
#!/usr/bin/env bash
racket ~/path/to/rodo.rkt "$@"
```
2018-09-08 01:11:59 +00:00
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 "$@"`
2018-05-20 02:03:00 +00:00
2018-09-08 01:11:59 +00:00
Make the **rodo** file executable by running`chmod u+x ~/bin/rodo`
2018-05-20 02:03:00 +00:00
2018-09-08 01:01:00 +00:00
### Windows
2018-09-08 01:02:24 +00:00
*Instructions coming soon*
2018-09-08 01:01:00 +00:00
### Mac
2018-09-08 01:02:24 +00:00
*Instructions coming soon*
2018-09-08 01:01:00 +00:00
2018-05-20 02:09:18 +00:00
## Usage
2018-05-20 02:03:00 +00:00
2018-09-08 01:11:59 +00:00
The below examples assume that you have **rodo** set up in your **$PATH** folder. If you don't, you would navigate to the directory of the **rodo.rkt** file and use `./rodo.rkt <command>` if the **rodo.rkt** is executable or `racket rodo.rkt <command>` if it is not.
2018-05-20 02:17:25 +00:00
2018-07-30 18:57:00 +00:00
### init
2018-05-20 02:17:25 +00:00
Initializes a file in `~/.rodo/todo-list` by default
2018-07-30 18:57:43 +00:00
Example: `rodo init`
2018-04-10 00:27:01 +00:00
2018-07-30 18:57:00 +00:00
### ls
Lists items from the list
2018-07-30 18:59:02 +00:00
Example: `rodo ls`
2018-04-13 06:14:51 +00:00
2018-07-30 18:57:00 +00:00
### add
2018-09-08 01:01:00 +00:00
Adds an entry to the list
#### Adding a single-word entry
2018-04-13 06:14:51 +00:00
2018-07-30 18:57:43 +00:00
Example: `rodo add bread`
2018-04-17 03:05:18 +00:00
2018-09-08 01:01:00 +00:00
#### Adding a multi-word entry
Example: `rodo add "go to the bank"`
2018-04-10 00:27:01 +00:00
2018-07-30 18:57:00 +00:00
### rm
Removes an item from the list
2018-04-13 06:14:51 +00:00
2018-07-30 18:57:43 +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
2018-09-08 01:01:00 +00:00
Right now, the configurations can be found in the `config.rkt` file. Settings such at **program name**, **path**, and **directory** can be set here.