rodo/README.md

133 lines
3.8 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:23:57 +00:00
# Table of Contents
2018-09-08 04:07:43 +00:00
* [Legend](https://github.com/m455/rodo#legend)
2018-09-08 01:23:57 +00:00
* [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)
2018-09-08 01:31:43 +00:00
* [Via Git](https://github.com/m455/rodo#via-git)
2018-09-08 04:07:43 +00:00
* [Setup](https://github.com/m455/rodo#setup)
2018-09-08 01:23:57 +00:00
* [GNU/Linux](https://github.com/m455/rodo#gnulinux)
2018-09-08 04:09:05 +00:00
* [Setup a $PATH](https://github.com/m455/rodo#setup-a-path)
2018-09-08 04:07:43 +00:00
* [Using the binary](https://github.com/m455/rodo#using-the-binary)
* [Creating a wrapper](https://github.com/m455/rodo#creating-a-wrapper)
2018-09-08 01:23:57 +00:00
* [Windows](https://github.com/m455/rodo#windows)
* [Mac](https://github.com/m455/rodo#mac)
* [Usage](https://github.com/m455/rodo#usage)
2018-09-08 02:31:45 +00:00
* [`init`](https://github.com/m455/rodo#init)
* [`ls`](https://github.com/m455/rodo#ls)
* [`add`](https://github.com/m455/rodo#add)
2018-09-08 01:23:57 +00:00
* [Adding a single-word entry](https://github.com/m455/rodo#adding-a-single-word-entry)
* [Adding a multi-word entry](https://github.com/m455/rodo#adding-a-multi-word-entry)
2018-09-08 02:31:45 +00:00
* [`rm`](https://github.com/m455/rodo#rm)
2018-09-08 01:23:57 +00:00
* [Configuration](https://github.com/m455/rodo#configuring-rodo)
2018-09-08 04:07:43 +00:00
## 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
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-09-08 01:30:36 +00:00
* [Racket 6.x](https://racket-lang.org/)
* [Git (Optional)](https://git-scm.com/)
2018-09-08 01:01:00 +00:00
## Download
2018-05-20 02:03:00 +00:00
2018-09-08 01:23:57 +00:00
### Via Browser
2018-09-08 01:34:04 +00:00
Download this repository by clicking the **Clone or download** button at the top right and then choosing **Download ZIP** from the drop-down list
2018-09-08 01:31:43 +00:00
### Via Git
Run `git clone https://github.com/m455/rodo` at the command line if you use Git
2018-09-08 01:23:57 +00:00
## Setup
2018-09-08 01:01:00 +00:00
### GNU/Linux
2018-09-08 04:07:43 +00:00
#### 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`
2018-09-08 04:07:43 +00:00
#### Using the binary
2018-09-08 04:07:43 +00:00
1. Copy the **rodo** binary file to your **$PATH** folder by running `cp /path/to/rodo ~/bin/`
2018-09-08 04:07:43 +00:00
2. Make sure the **rodo** binary file is executable by running `chmod u+x ~/bin/rodo`
2018-09-08 04:07:43 +00:00
#### Creating a wrapper
Create an empty wrapper file by running `touch ~/bin/rodo` and then add the following contents to it and save:
2018-05-20 02:03:00 +00:00
```
#!/usr/bin/env bash
racket ~/path/to/rodo.rkt "$@"
```
2018-09-08 04:07:43 +00:00
**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`
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 04:09:05 +00:00
The below examples assume that you have **rodo** [set up](https://github.com/m455/rodo#setup-a-path) in your **$PATH** folder.
2018-09-08 04:07:43 +00:00
**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.
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.