updated quick start section in readme
parent
f29f3e3403
commit
034d0c1fcd
13
README.md
13
README.md
|
@ -10,6 +10,7 @@ A minimal list manager for people who live on the command line.
|
||||||
# Table of Contents
|
# Table of Contents
|
||||||
|
|
||||||
- [Quick start](#quick-start)
|
- [Quick start](#quick-start)
|
||||||
|
- [Creating a wrapper](#creating-a-wrapper)
|
||||||
- [Getting started](#getting-started)
|
- [Getting started](#getting-started)
|
||||||
- [Conventions used in this readme](#conventions-used-in-this-readme)
|
- [Conventions used in this readme](#conventions-used-in-this-readme)
|
||||||
- [Platforms](#platforms)
|
- [Platforms](#platforms)
|
||||||
|
@ -55,20 +56,16 @@ command line environment, or scripting.
|
||||||
* To use rodo as an single-file executable follow the steps below:
|
* To use rodo as an single-file executable follow the steps below:
|
||||||
1. Run `raco exe rodo.rkt` to compile rodo into a single-file executable
|
1. Run `raco exe rodo.rkt` to compile rodo into a single-file executable
|
||||||
2. Run `./rodo`
|
2. Run `./rodo`
|
||||||
5. (optional) Create a wrapper in your `$PATH` directory to run rodo from anywhere:
|
3. Optional: Move the single-file executable, `rodo`, to your `$PATH`
|
||||||
|
|
||||||
|
## Creating a wrapper
|
||||||
|
Create a wrapper in your `$PATH` directory to run rodo from anywhere:
|
||||||
|
|
||||||
```
|
```
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
racket ~/path/to/rodo.rkt "$@"
|
racket ~/path/to/rodo.rkt "$@"
|
||||||
```
|
```
|
||||||
|
|
||||||
If you are using a single-file executable, create a wrapper as follows:
|
|
||||||
|
|
||||||
```
|
|
||||||
#!/usr/bin/env bash
|
|
||||||
~/path/to/rodo "$@"
|
|
||||||
```
|
|
||||||
|
|
||||||
# Getting started
|
# Getting started
|
||||||
|
|
||||||
This readme will guide you through downloading, setting up, and using the rodo
|
This readme will guide you through downloading, setting up, and using the rodo
|
||||||
|
|
Binary file not shown.
Binary file not shown.
Loading…
Reference in New Issue