aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index f13f5ed..8559ca2 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,11 @@ make -j$(nproc)
make test
```
+`make test` runs the server/protocol suite, the TUI unit tests and a docs/code
+consistency check. Extra targets: `make test-asan` / `make test-ubsan`
+(sanitizers) and `make test-pty` (drives the real TUI over a pty against a
+throwaway `/tmp` daemon and asserts on screen text).
+
Produces `build/bokfd` (daemon), `build/bokfctl` (CLI) and `build/bokftui`
(ncurses UI). Builds on x86_64 and arm64 (Armbian, Raspberry Pi, …).