Browse Source

Update README

master
cancel 6 years ago
parent
commit
0372f9d7b4
  1. 16
      README.md

16
README.md

@ -2,12 +2,16 @@ C engine for the ORCΛ programming environment, with a commandline interpreter.
## Prerequisites ## Prerequisites
libc, POSIX, C99 compiler, `make`. Tested to build on Linux and Mac (gcc, POSIX, C99 compiler, `bash` for the build script. Tested to build on Linux and
clang.) No native Windows port yet, but it will probably build with cygwin Mac with GCC and clang. No native Windows port yet, but it will probably
already. already build under cygwin.
## Build ## Build
You can use the build script directly, or with the `make` wrapper.
### Make
```sh ```sh
make [debug or release, default is debug] make [debug or release, default is debug]
``` ```
@ -20,6 +24,10 @@ make clean
``` ```
Removes `build/` Removes `build/`
### Build Script
Run `./tool --help` to see usage info.
## Run ## Run
```sh ```sh
@ -28,5 +36,5 @@ orca [-t timesteps] infile
You can also make orca read from stdin: You can also make orca read from stdin:
```sh ```sh
echo -e "...\na34\n..." | orca -t 1 /dev/stdin echo -e "...\na34\n..." | orca /dev/stdin
``` ```

Loading…
Cancel
Save