From f9c0a7c949399b4470f2c8b83f84076f3dd6d2af Mon Sep 17 00:00:00 2001 From: francois Date: Mon, 8 Jun 2026 19:45:49 +0200 Subject: [PATCH] =?UTF-8?q?doc:=20README=20=E2=80=94=20trim=20quick=20star?= =?UTF-8?q?t,=20GUI=20flag=20inline?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 4.8 --- README.md | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a97419e..efdf1cb 100644 --- a/README.md +++ b/README.md @@ -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//` that links it. Select one with -`-DESSIM_FRONTEND=` (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).