diff options
| author | Christophe Besson <cbesson@gmail.com> | 2026-09-19 01:49:11 +0200 |
|---|---|---|
| committer | Christophe Besson <cbesson@gmail.com> | 2026-09-19 01:49:56 +0200 |
| commit | 3e7c7eba8e512df852da38a6b9ddd8467ec4d4e7 (patch) | |
| tree | ac529c48cb40cb4c795a61345365fca07f47e965 /CLAUDE.md | |
| parent | c2c49182e6d4f1f1ef3ed3ba5e8699912f9a27bd (diff) | |
| download | meshbay-3e7c7eba8e512df852da38a6b9ddd8467ec4d4e7.tar.gz | |
docs: add a quickstart and a user guide
QUICKSTART takes one Linux machine from downloaded packages to a working
group with a second member. USERGUIDE covers using a group and running a
node, for a reader who is not a developer. Windows stays in
PACKAGING-GUIDE.md.
Both are written from the code — the CLI, ops.py, the systemd units and
the interface catalogue — rather than from the specification, and they
state what is not built as readily as what is.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Diffstat (limited to 'CLAUDE.md')
| -rw-r--r-- | CLAUDE.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -13,6 +13,14 @@ optional hub feature and are off on the reference deployment. `docs/` is either an operational guide, or a superseded document kept for its cross-references and carrying a banner that says so. +**`docs/QUICKSTART.md` and `docs/USERGUIDE.md` are the user documentation** — +written for somebody who is not a developer, Linux and the browser only. They +name CLI verbs, default values, setting names and interface labels, so a change +to any of those is a change to them: the previous user guide was retired +because it had drifted past the point where a reader could tell which half was +still true. What keeps them honest is that they state what is *not* built as +readily as what is (§15.2, §15.3); a feature that lands deletes its line there. + ## Repository structure ``` |