electronics/essim
1
0
Fork 0
Code Issues 3 Pull Requests Packages Releases Wiki Activity

doc: README — trim quick start, GUI flag inline

Browse Source 
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Foué
2026-06-08 19:45:49 +02:00
parent c9367f134e
commit f9c0a7c949
1 changed files with 3 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -10,28 +10,13 @@ Status: early work-in-progress.
## Quick start
```sh
cmake -S . -B build
cmake -S . -B build # TUI (default); add -DESSIM_FRONTEND=wx for the GUI
cmake --build build -j
./build/essim
```
The build is **layered**: `essim_core` is the frontend-agnostic business
library (domain + importers + operations); the `essim` binary comes from a
**frontend** under `src/frontends/<name>/` that links it. Select one with
`-DESSIM_FRONTEND=<name>` (default `tui`); `-DESSIM_FRONTEND=none` builds the
core + tests only, with no GUI toolkit fetched. Architecture in
[`DESIGN.md`](DESIGN.md).
The quick start above builds the **tui** (terminal) frontend. For the
**wxWidgets GUI** instead (needs wxWidgets ≥ 3.2, see *Dependencies*):
```sh
cmake -S . -B build -DESSIM_FRONTEND=wx
cmake --build build -j
./build/essim
```
Switching `-DESSIM_FRONTEND` on an existing `build/` reconfigures it in place.
Frontends: `tui` (terminal, default), `wx` (wxWidgets GUI), `none` (core +
tests, no GUI toolkit). Architecture in [`DESIGN.md`](DESIGN.md).
Inside the shell, type `help` for the live command list — or read the
auto-generated reference at [`doc/user/commands.md`](doc/user/commands.md).