docs: document the BSDL workflow + add a batch/TUI tutorial

DESIGN.md: libbsdl dependency and --batch headless mode; bsdl_model/bsdl_check
in the layout; the attach-bsdl command and the `B` persist tag; PinSpec is now
BSDL-populated; verify's five passes incl. the model-driven and JTAG checks
and the new AnomalyKinds. README: libbsdl dependency, --batch usage, tutorial
link. New doc/user/tutorial.md: end-to-end batch and TUI walkthroughs (load →
tag → connect → attach-bsdl → verify, with the pin/JTAG findings explained).
Regenerated commands.md (adds attach-bsdl); index.md links the tutorial.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
2026-06-03 15:46:56 +02:00
parent 581028a83d
commit a4f8254cb3
5 changed files with 274 additions and 10 deletions

View File

@@ -20,6 +20,15 @@ auto-generated reference at [`doc/user/commands.md`](doc/user/commands.md).
A worked bring-up script is at [`test/system.essim`](test/system.essim);
load it with `source test/system.essim`.
To run a script without the TUI and print its output to stdout (CI-friendly):
```sh
./build/essim --batch --source bring-up.essim
```
Step-by-step walkthroughs for both the batch and TUI workflows are in
[`doc/user/tutorial.md`](doc/user/tutorial.md).
## Dependencies
- **C++17 compiler** and **CMake 3.14+**.
@@ -28,6 +37,10 @@ load it with `source test/system.essim`.
- Debian/Ubuntu — `sudo apt install libzip-dev libpugixml-dev`
- Arch — `sudo pacman -S libzip pugixml`
- Fedora — `sudo dnf install libzip-devel pugixml-devel`
- **libbsdl** — the standalone BSDL parser, a sibling repo expected at
`../libbsdl`, pulled in via `add_subdirectory` and linked dynamically.
Override its location with `-DBSDL_DIR=/path/to/libbsdl`. Powers the
`attach-bsdl` command and the pin/JTAG checks.
- Fetched automatically at configure time via `FetchContent` (nothing to
install): **FTXUI** v6.1.9 and **doctest** v2.4.11.
- Optional, only for the `doc` target: **doxygen** and **python3**.