diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f1f6d17..c8f3f1bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,12 +16,19 @@ You need stable Rust 1.95 or newer (required by egui/eframe 0.36). For the web build you also need `rustup target add wasm32-unknown-unknown` and [`trunk`](https://trunkrs.dev). ```sh -git clone https://github.com/bherbruck/solidcraft && cd solvecraft +git clone https://github.com/bherbruck/solidcraft && cd solidcraft cargo run --release -p solvecraft -- --sample # desktop app with a sample part cargo xtask test # unit, engine and UI-scenario tests cargo xtask ci # everything a PR must pass (see below) ``` +SolidCraft is the product and repository name. Cargo packages and executables retain +their `solvecraft` names for compatibility with existing scripts and MCP clients. +Build the desktop app with `cargo build --release -p solvecraft`, or the CLI with +`cargo build --release -p solvecraft-cli`. Run the CLI with +`cargo run --release -p solvecraft-cli -- commands` (or `target/release/solvecraft-cli commands` +after building). There is no Cargo package named `solidcraft`. + Web: `cd apps/solvecraft-web && trunk serve --release`, then open the printed URL (`?sample` opens the sample part, `?webgl` forces WebGL2). Saving and opening files in the browser needs HTTPS or localhost, because it uses the Origin Private File System.