tildetown
/
rodo
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

main
Jesse Laprade 2018-09-07 21:01:00 -04:00 committed by GitHub
parent 5276b8f50f
commit 2526ff0bf6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -2,18 +2,30 @@
An easy-to-use todo list program for people who live on the command line written in Racket. An easy-to-use todo list program for people who live on the command line written in Racket.
### Requirements ## Platforms
* GNU/Linux * GNU/Linux
* Microsoft Windows
* OS X
## Requirements
* Racket 6.x * Racket 6.x
* Git (Optional)
### Setting up rodo ## Download
#### Using the Linux binary Download this repository by clicking the `Clone or download` button at the top, then click `Download ZIP`
Download rodo by running: **or**
`git clone https://github.com/m455/rodo` Run `git clone https://github.com/m455/rodo` at the command line if you use Git
## Setting up rodo
### GNU/Linux
#### Using the executable binary
Create a $PATH if you haven't done so already by running: Create a $PATH if you haven't done so already by running:
@ -27,19 +39,7 @@ Add the `rodo` binary to your $PATH folder (in your ~/bin/ folder if you followe
`chmod u+x ~/bin/rodo` `chmod u+x ~/bin/rodo`
#### Manually #### Using and creating a wrapper
Download rodo by running:
`git clone https://github.com/m455/rodo`
Create a $PATH if you haven't done so already by running:
`echo "export PATH=~/bin:\$PATH" >> .bashrc`
Make the actual directory for your `$PATH`:
`mkdir ~/bin/`
Create a file called `rodo` in your $PATH folder (in your ~/bin/ folder if you followed the instructions above) and add the Create a file called `rodo` in your $PATH folder (in your ~/bin/ folder if you followed the instructions above) and add the
following contents to it: following contents to it:
@ -61,6 +61,14 @@ Make the `rodo` file executable:
`chmod u+x ~/bin/rodo` `chmod u+x ~/bin/rodo`
### Windows
Instructions coming soon
### Mac
Instructions coming soon
## Usage ## Usage
The below examples assume that you have rodo set up in your The below examples assume that you have rodo set up in your
@ -82,12 +90,15 @@ Example: `rodo ls`
### add ### add
Adds an item to the list Adds an entry to the list
#### Adding a single-word entry
Example: `rodo add bread` Example: `rodo add bread`
**Note:** For multi-word items you will need to surround your item in double quotes like this: #### Adding a multi-word entry
`$ rodo add "go to the bank"`
Example: `rodo add "go to the bank"`
### rm ### rm
@ -99,4 +110,4 @@ Example: `rodo rm 1`
## Configuring rodo ## 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. Right now, the configurations can be found in the `config.rkt` file. Settings such at **program name**, **path**, and **directory** can be set here.