added todo list
parent
89559fdf1f
commit
9e28811174
37
README.md
37
README.md
|
@ -2,6 +2,9 @@
|
||||||
|
|
||||||
A simple to-do list tool for people who live on the command-line
|
A simple to-do list tool for people who live on the command-line
|
||||||
|
|
||||||
|
# Todos
|
||||||
|
- [ ] Only allow quoted items to be added
|
||||||
|
|
||||||
By: Jesse Laprade
|
By: Jesse Laprade
|
||||||
|
|
||||||
![](screenshot.png)
|
![](screenshot.png)
|
||||||
|
@ -12,7 +15,7 @@ By: Jesse Laprade
|
||||||
* [Requirements](https://github.com/m455/rodo#requirements)
|
* [Requirements](https://github.com/m455/rodo#requirements)
|
||||||
* [Downloading](https://github.com/m455/rodo#downloading)
|
* [Downloading](https://github.com/m455/rodo#downloading)
|
||||||
* [Setup](https://github.com/m455/rodo#setup)
|
* [Setup](https://github.com/m455/rodo#setup)
|
||||||
* [GNU/Linux](https://github.com/m455/rodo#gnulinux)
|
* [GNU/Linux](https://github.com/m455/rodo#gnulinux)
|
||||||
* [Usage](https://github.com/m455/rodo#usage)
|
* [Usage](https://github.com/m455/rodo#usage)
|
||||||
* [Examples](https://github.com/m455/rodo#examples)
|
* [Examples](https://github.com/m455/rodo#examples)
|
||||||
* [Configuration](https://github.com/m455/rodo#configuring-rodo)
|
* [Configuration](https://github.com/m455/rodo#configuring-rodo)
|
||||||
|
@ -29,34 +32,34 @@ By: Jesse Laprade
|
||||||
## Downloading
|
## Downloading
|
||||||
|
|
||||||
* Via Browser
|
* Via Browser
|
||||||
* Download this repository by clicking the **Clone or download** button at the top right, then choose **Download ZIP** from the drop-down list
|
* Download this repository by clicking the **Clone or download** button at the top right, then choose **Download ZIP** from the drop-down list
|
||||||
|
|
||||||
* Via Git
|
* Via Git
|
||||||
* Run `git clone https://github.com/m455/rodo` at the command line
|
* Run `git clone https://github.com/m455/rodo` at the command line
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
### GNU/Linux
|
### GNU/Linux
|
||||||
|
|
||||||
1. Setup a $PATH
|
1. Setup a $PATH
|
||||||
1. Create a directory for your `$PATH` by running `mkdir ~/bin/`
|
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`
|
2. Associate your `$PATH` with the ~/bin/ folder you created by running `echo "export PATH=~/bin:\$PATH" >> .bashrc`
|
||||||
|
|
||||||
2. Using the binary
|
2. Using the binary
|
||||||
1. Copy the rodo binary file to your `$PATH` folder by running `cp /path/to/rodo ~/bin/`
|
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`
|
2. Make the rodo binary file executable by running `chmod u+x ~/bin/rodo`
|
||||||
|
|
||||||
3. Creating a wrapper
|
3. Creating a wrapper
|
||||||
1. Create an empty wrapper file by running `touch ~/bin/rodo`.
|
1. Create an empty wrapper file by running `touch ~/bin/rodo`.
|
||||||
2. Add the following contents show below to it
|
2. Add the following contents show below to it
|
||||||
```
|
```
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
racket ~/path/to/rodo.rkt "$@"
|
racket ~/path/to/rodo.rkt "$@"
|
||||||
```
|
```
|
||||||
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 "$@"`
|
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 "$@"`
|
||||||
|
|
||||||
3. Save the file
|
3. Save the file
|
||||||
4. Make the rodo wrapper file executable by running`chmod u+x ~/bin/rodo`
|
4. Make the rodo wrapper file executable by running`chmod u+x ~/bin/rodo`
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue