From c159a9d29485f1e93a6533d565a60e19cd3979ba Mon Sep 17 00:00:00 2001 From: CJ van den Berg Date: Wed, 15 Oct 2025 10:52:09 +0200 Subject: [PATCH] docs: add a Documentation section to the readme --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 46e487d..e197180 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,23 @@ zig build -Doptimize=ReleaseSafe -Dtarget=aarch64-linux-musl --prefix zig-out/aa When cross-compiling zig will build a binary with generic CPU support. -[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/neurocyte/flow) + +# Documentation + +## User manual + +A basic user manual is available inside flow. You can open it with the +`Open help` command (F1). + +## Development Resources + +Also, additional developer resources can be found on the Flow Control website at +[flow-control.dev/docs](https://flow-control.dev/docs/). + +There is also an AI generated developer guide at +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/neurocyte/flow). +Accuracy may vary. Check details against the referenced source code. + # Running Flow Control