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

Update README.md

main
Jesse Laprade 2018-09-07 21:11:59 -04:00 committed by GitHub
parent 79cf5afc5d
commit d41927a8ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -28,39 +28,22 @@ Run `git clone https://github.com/m455/rodo` at the command line if you use Git
#### 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 `echo "export PATH=~/bin:\$PATH" >> .bashrc`
`echo "export PATH=~/bin:\$PATH" >> .bashrc`
Make the actual directory for your **$PATH** by running `mkdir ~/bin/`
Make the actual directory for your `$PATH`:
`mkdir ~/bin/`
Add the `rodo` binary to your $PATH folder (in your ~/bin/ folder if you followed the instructions above) and make sure it's executable:
`chmod u+x ~/bin/rodo`
Add the **rodo** binary to your **$PATH** folder (in your **~/bin/** folder if you followed the instructions above) and make sure it's executable by running `chmod u+x ~/bin/rodo`
#### Using and creating a wrapper
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:
Create a file called **rodo** in your **$PATH** folder (in your ~/bin/ folder if you followed the instructions above) by running `touch ~/bin/rodo` and then add the following contents to it:
```
#!/usr/bin/env bash
racket ~/path/to/rodo.rkt "$@"
```
For example, if you `git clone`d the project to your
`~/downloads/` folder you would change the line:
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 "$@"`
`racket ~/path/to/rodo.rkt "$@"`
to
`racket ~/downloads/rodo/rodo.rkt "$@"`
Make the `rodo` file executable:
`chmod u+x ~/bin/rodo`
Make the **rodo** file executable by running`chmod u+x ~/bin/rodo`
### Windows
@ -72,10 +55,7 @@ Make the `rodo` file executable:
## Usage
The below examples assume that you have rodo set up in your
$PATH folder. If you don't, you would simply go to the
directory of the `rodo.rkt` file and use `./rodo <command>`
instead.
The below examples assume that you have **rodo** set up in your **$PATH** folder. If you don't, you would navigate to the directory of the **rodo.rkt** file and use `./rodo.rkt <command>` if the **rodo.rkt** is executable or `racket rodo.rkt <command>` if it is not.
### init