ref: b2a737ed9d9a363a4258c998c104c0bf586ca5df
parent: 97d23fbe333a117bac6c69def5b9f2798221082f
author: Lennart Augustsson <lennart.augustsson@epicgames.com>
date: Tue Aug 29 06:50:47 EDT 2023
More docs.
--- a/README.md
+++ b/README.md
@@ -98,11 +98,18 @@
It is written in a reasonably portable C code.
### Runtime flags
+Runtime flags are given between the flags `+RTS` and `-RTS`.
+Btween those the runtime decodes the flags, everything else is available to
+the running program.
+
* `-HSIZE` set heap size to `SIZE` cells, can be suffixed by `k`, `M`, or `G`, default is `100k`
* `-KSIZE` set stack size to `SIZE` entries, can be suffixed by `k`, `M`, or `G`, default is`10k`
* `-rFILE` read combinators from `FILE`, instead of `out.comb`
* `-v` be more verbose, flag can be repeated
-* `--` end of flags, the rest of the arguments are available to the running program
+
+For example, `bin/eval +RTS -H1M -v -RTS hello` runs `out.comb` and the program gets the argument `hello`,
+whereas the runtime system sets the heap to 1M cells and is verbose.
+
### Features
The runtime system can serialize and deserialize any expression
--
⑨