ref: 0372f9d7b40bb2523298b27ed5635a448d4d283e
parent: f2a12c0104325ec01ac718e9738a844ec3ad18fb
author: cancel <cancel@cancel.fm>
date: Thu Nov 29 13:37:09 EST 2018
Update README
--- a/README.md
+++ b/README.md
@@ -2,12 +2,16 @@
## Prerequisites
-libc, POSIX, C99 compiler, `make`. Tested to build on Linux and Mac (gcc,
-clang.) No native Windows port yet, but it will probably build with cygwin
-already.
+POSIX, C99 compiler, `bash` for the build script. Tested to build on Linux and
+Mac with GCC and clang. No native Windows port yet, but it will probably
+already build under cygwin.
## Build
+You can use the build script directly, or with the `make` wrapper.
+
+### Make
+
```sh
make [debug or release, default is debug]
```
@@ -20,6 +24,10 @@
```
Removes `build/`
+### Build Script
+
+Run `./tool --help` to see usage info.
+
## Run
```sh
@@ -28,5 +36,5 @@
You can also make orca read from stdin:
```sh
-echo -e "...\na34\n..." | orca -t 1 /dev/stdin
+echo -e "...\na34\n..." | orca /dev/stdin
```