From ac44015d23667a9e064f9e934083c0ef015bccc7 Mon Sep 17 00:00:00 2001 From: Hermes Agent Date: Mon, 25 May 2026 21:08:30 -0400 Subject: [PATCH] docs: align cargo run examples with CLI default-run --- .gitignore | 3 +++ Cargo.toml | 1 + README.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/.gitignore b/.gitignore index 394c1bd..186cb54 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,9 @@ # Local research/extraction scratch /.work/ +# Checked-in demo script outputs +/examples/demo-render.png + # Proprietary/local reference payloads. Keep these locally only. /reference/ diff --git a/Cargo.toml b/Cargo.toml index 29fb02a..e1a2ea6 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,4 +1,5 @@ [package] +default-run = "openvistapro" name = "openvistapro" version = "0.1.0" edition = "2024" diff --git a/README.md b/README.md index 83d2b44..72514c0 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ cargo run -- render --preset hill --quality final --output /tmp/openvistapro-ren cargo run --features app --bin openvistapro_app ``` +The crate’s default `cargo run` target is the CLI binary (`openvistapro`), so the commands above work without an extra `--bin` flag. Use `--features app --bin openvistapro_app` for the optional GUI shell. + The optional app shell is gated behind the `app` feature so default CLI builds stay GPU-free. It opens an `eframe`/`egui` window titled `OpenVistaPro` with scene controls, top-level menus/dialogs, and a CPU-rendered terrain preview. The native shell uses eframe's Glow renderer under X11/Xvfb, which keeps the app smoke launch independent of WGPU backend feature selection. -- 2.39.5