118 lines
3.0 KiB
Markdown
Executable File
118 lines
3.0 KiB
Markdown
Executable File
# rodo
|
|
|
|
A simple to-do list tool for people who live on the command-line
|
|
|
|
By: Jesse Laprade
|
|
|
|
|
|
|
|
# Table of Contents
|
|
|
|
* [Legend](https://github.com/m455/rodo#legend)
|
|
* [Platforms](https://github.com/m455/rodo#platforms)
|
|
* [Requirements](https://github.com/m455/rodo#requirements)
|
|
* [Download](https://github.com/m455/rodo#download)
|
|
* [Via Browser](https://github.com/m455/rodo#via-browser)
|
|
* [Via Git](https://github.com/m455/rodo#via-git)
|
|
* [Setup](https://github.com/m455/rodo#setup)
|
|
* [GNU/Linux](https://github.com/m455/rodo#gnulinux)
|
|
* [Setup a $PATH](https://github.com/m455/rodo#setup-a-path)
|
|
* [Using the binary](https://github.com/m455/rodo#using-the-binary)
|
|
* [Creating a wrapper](https://github.com/m455/rodo#creating-a-wrapper)
|
|
* [Usage](https://github.com/m455/rodo#usage)
|
|
* [Examples](https://github.com/m455/rodo#examples)
|
|
* [Configuration](https://github.com/m455/rodo#configuring-rodo)
|
|
|
|
## Legend
|
|
|
|
`Items marked like this` are either instructions for running on the command line or code. Do not include the initial `$` when running them.
|
|
|
|
**Items marked like this** are important.
|
|
|
|
## Platforms
|
|
|
|
* GNU/Linux
|
|
|
|
## Requirements
|
|
|
|
* [Racket 6.x](https://racket-lang.org/)
|
|
* [Git (Optional)](https://git-scm.com/)
|
|
|
|
## Download
|
|
|
|
### Via Browser
|
|
|
|
Download this repository by clicking the **Clone or download** button at the top right and then choosing **Download ZIP** from the drop-down list
|
|
|
|
### Via Git
|
|
|
|
Run `git clone https://github.com/m455/rodo` at the command line if you use Git
|
|
|
|
## Setup
|
|
|
|
### GNU/Linux
|
|
|
|
#### 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`
|
|
|
|
#### 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`
|
|
|
|
#### 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 "$@"
|
|
```
|
|
3. Save the file
|
|
|
|
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 "$@"`
|
|
|
|
2. Make the rodo wrapper file executable by running`chmod u+x ~/bin/rodo`
|
|
|
|
## Usage
|
|
|
|
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
|
|
|
|
The examples below assume that you have rodo [set up](https://github.com/m455/rodo#setup-a-path) in your `$PATH`
|
|
|
|
init - `rodo init`
|
|
|
|
ls - `rodo ls`
|
|
|
|
add (Single-word entry) - `rodo add bread`
|
|
|
|
add (Multi-word entry) - `rodo add "go to the bank"`
|
|
|
|
rm - `rodo rm 1`
|
|
|
|
## 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.
|