From ff71d988328161b54c147e962aa6be63ca572845 Mon Sep 17 00:00:00 2001 From: m455 Date: Fri, 12 Apr 2019 09:23:46 -0400 Subject: [PATCH] updated readme --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 57d1988..51b08b0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # rodo -A simple todo list application for people who live in the terminal +A easy-to-use todo list program for people who live on the command line # Screenshot @@ -24,14 +24,22 @@ Now the default directory and todo list file have better default permissions: 1. Make sure [Racket](https://racket-lang.org/) is installed 2. `git clone https://github.com/m455/rodo` into a directory of your choice -3. Run `racket rodo.rkt` or, if you want an executable, run `raco exe rodo.rkt` to compile the project into a single executable file, and then run that. -4. Add the following to your `$PATH` directory to run `rodo` from anywhere, depending on whether or not you are using the `rodo.rkt` file or a compiled executable file: +3. `cd` into the `rodo` directory +4. Run one of the following commands: + * To use `rodo` using the Racket interpreter run: `racket rodo.rkt` + * To use `rodo` as an single-file executable follow the two steps below: + 1. Run `raco exe rodo.rkt` to compile the `rodo` into a single-file executable + 2. Run `./rodo` +5. (optional) Add the following to your `$PATH` directory to run `rodo` from +anywhere. ``` #!/usr/bin/env bash racket ~/path/to/rodo.rkt "$@" ``` +Note: If you made an executable, remember to change the `rodo.rkt` part above to just `rodo` + # Table of Contents * [Platforms](https://github.com/m455/rodo#platforms)