aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 86d40be..2da2245 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,27 @@ a **suckless** and **minimal**, **POSIX C99** alternative to `Makefile`/`justfil
---
+## install `rf`
+
+you can either install the AUR package `rf` with your favourite AUR helper
+
+or build rfile manually with `gcc` or any other POSIX C99 compiler
+
+---
+
+## extra compile options
+
+you can enable the following flags to enable extra feautures for `rf`:
+
+> using `gcc` you can do `gcc -D FLAG_NAME ...`
+
+- `RF_EXTRAS`: enables all `EXTRA_*` features
+- `RF_EXTRA_MORE_COMMENTS`: enables `//` and `--` comments for `rfile`s
+- `RF_HIDDEN_CMD`: hides the `$ cmd` for commands
+- `RF_MAX_VARS=num` : ovverrides the default number (512) of maximum variables
+
+---
+
## `rfile` syntax & features
- `#` -> ignore line (comment)