From b1cf9ca888c3df3b20382f6daea35c6a58d06ec4 Mon Sep 17 00:00:00 2001
From: czjstmax <jstmaxlol@disroot.org>
Date: Thu, 14 May 2026 18:33:34 +0200
Subject: add documentation and extra flags

Signed-off-by: czjstmax <jstmaxlol@disroot.org>
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 86d40be..41ca9dc 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,26 @@ 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
+
+---
+
 ## `rfile` syntax & features
 
 - `#` -> ignore line (comment)
-- 
cgit v1.3.1