ba45be8d91 | ||
---|---|---|
LICENSE | ||
README.md | ||
args.rkt | ||
config.rkt | ||
init.rkt | ||
io.rkt | ||
messages.rkt | ||
rodo | ||
rodo.rkt | ||
util.rkt |
README.md
rodo
An easy-to-use todo list program for people who live on the command line written in Racket
Table of Contents
Legend
Items marked like this
are commands for running on the command line
Items marked like this are keywords, buttons, variables or specific files/folders
Platforms
- GNU/Linux
- Microsoft Windows
- OS X
Requirements
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
-
Create a directory for your $PATH by running
mkdir ~/bin/
-
Associate your $PATH with the ~/bin/ folder you created by running
echo "export PATH=~/bin:\$PATH" >> .bashrc
Using the binary
-
Copy the rodo binary file to your $PATH folder by running
cp /path/to/rodo ~/bin/
-
Make sure the rodo binary file is executable by running
chmod u+x ~/bin/rodo
Creating a wrapper
- Create an empty wrapper file by running
touch ~/bin/rodo
and then add the following contents to it and save:
#!/usr/bin/env bash
racket ~/path/to/rodo.rkt "$@"
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 "
@"
- Make the rodo wrapper file executable by running
chmod u+x ~/bin/rodo
Windows
Instructions coming soon
Mac
Instructions coming soon
Usage
The below examples assume that you have rodo set up in your $PATH folder.
If you don't: Navigate to the directory of the rodo.rkt file and use ./rodo.rkt <command-from-below>
if the rodo.rkt is executable or racket rodo.rkt <command>
if it is not.
init
- Initializes a file in ~/.rodo/todo-list by default
Example: rodo init
ls
- Lists items from the list
Example: rodo ls
add
- Adds an entry to the list
Example of adding a single-word entry: rodo add bread
Example of adding a multi-word entry: rodo add "go to the bank"
rm
- Removes an item from the list
Example: rodo rm 1
Note: You may have to run rodo ls
to see which number corresponds to which item to remove it.
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.