From 3ffed8f8bef036ad0e905547f9cb88649dafae11 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Mon, 16 Nov 2026 10:44:41 +0100 Subject: [PATCH] Restore top build badges and prepare release metadata and bundle instructions --- README.md | 19 ++++----- crates/canvas-pilot/Cargo.toml | 5 +++ docs/canvas-pilot/changelog.md | 5 +++ docs/canvas-pilot/portable-quickstart.txt | 26 ++++++++++++ docs/development/handoff.md | 5 ++- docs/development/releases.md | 48 ++++++++++++++++++++++- rust-release.toml | 2 +- 7 files changed, 94 insertions(+), 16 deletions(-) create mode 100644 docs/canvas-pilot/portable-quickstart.txt diff --git a/README.md b/README.md index 0379a5c..8c4bdc9 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ Canvas Pilot icon

Canvas Pilot

+ +

+ Version + Tests + Coverage +

+

Compose your screen layout. Frame every layer. Bring it to the switcher.

@@ -120,19 +127,7 @@ For bug reports, include your OS, application version, steps to reproduce and, for device issues, the model and firmware. Contributors can start with the [development guide](docs/development/README.md) and [file/device contracts](docs/interfaces/README.md). -

-Build status -The badges below become available after the standalone Jenkins pipeline publishes -its first results. See [CI setup and local checks](docs/development/ci.md). - -

- Version - Tests - Coverage -

- -
--- diff --git a/crates/canvas-pilot/Cargo.toml b/crates/canvas-pilot/Cargo.toml index 2484814..e5b3c39 100644 --- a/crates/canvas-pilot/Cargo.toml +++ b/crates/canvas-pilot/Cargo.toml @@ -6,6 +6,11 @@ license.workspace = true repository.workspace = true description = "Screen layout design, geometry import and reviewed device control" +[package.metadata.binstall] +pkg-url = "{ repo }/releases/download/v{ version }/{ name }-{ target }-v{ version }.tgz" +pkg-fmt = "tgz" +bin-dir = "{ name }-{ target }-v{ version }/{ bin }{ binary-ext }" + [features] default = ["vendor_formats"] vendor_formats = ["dep:craft-dwg", "dep:deckcraft-pptx", "dep:deckcraft-model", "dep:deckcraft-geom", "dep:figcraft-format", "dep:figcraft-doc", "dep:figcraft-geom"] diff --git a/docs/canvas-pilot/changelog.md b/docs/canvas-pilot/changelog.md index e6adbf8..7339b48 100644 --- a/docs/canvas-pilot/changelog.md +++ b/docs/canvas-pilot/changelog.md @@ -4,6 +4,11 @@ ## Unreleased +- Restored build-status badges to the top of the README. Checked release readiness + without compilation or publication, added required cargo-binstall metadata and + replaced the portable archive's repository README with standalone instructions. + + - Saved a conversation handoff for reopening the standalone project, including pending input-ratio scope, planned videos, device-test context and publication state. Linked it from agent/developer guidance and retained pending plans in diff --git a/docs/canvas-pilot/portable-quickstart.txt b/docs/canvas-pilot/portable-quickstart.txt new file mode 100644 index 0000000..c364c24 --- /dev/null +++ b/docs/canvas-pilot/portable-quickstart.txt @@ -0,0 +1,26 @@ +Canvas Pilot - portable quick start +=================================== + +Extract the complete archive before running the application. Run canvas-pilot.exe +on Windows, or ./canvas-pilot on Linux/macOS. Choose the archive matching your OS +and CPU; macOS builds target macOS 13 or newer. A graphical desktop is required. +Linux requires the desktop/OpenGL runtime libraries used by the application. + +Start offline: arrange the example layers, adjust their crop and save your project. +A device connection is optional. Review device mappings and transfer destinations +before explicitly sending a layout to a switcher. + +Manual: https://books.dandaedre.com/manuals/canvas-pilot/ +Project, templates and help: https://proxy.dandaedre.com/gitea/idle-org/canvas-pilot + +Optional desktop launchers (Python 3.11+): + Linux: python3 scripts/create-desktop-launcher.py canvas-pilot --binary "$PWD/canvas-pilot" --output "$HOME/.local/share" + macOS: python3 scripts/create-desktop-launcher.py canvas-pilot --platform macos --binary "$PWD/canvas-pilot" --output "$HOME/Applications" +Run these commands from the extracted directory. Linux launchers reference this +location; keep it in a permanent folder. macOS launchers copy the executable. +The helper does not sign/notarize the application or bypass OS security checks. + +FFprobe is not required. Illustrator AI exchange needs a separately installed +VectorCraft CLI; SVG exchange can be used without it. + +License: LICENSES/MIT.txt. Independent software, not affiliated with Analog Way. diff --git a/docs/development/handoff.md b/docs/development/handoff.md index 918accb..c15c02b 100644 --- a/docs/development/handoff.md +++ b/docs/development/handoff.md @@ -39,8 +39,9 @@ These settings are server-side; they do not require a Git commit. The new Jenkins job hookup has not been performed in this conversation. Setup is in [CI](ci.md). The three new badge URLs returned HTTP 404 at the last check; -the README therefore keeps them in a collapsed Build status section pending the -first publication. No new book deployment was performed during migration. +the README initially kept them in a collapsed Build status section pending the +first publication. The user subsequently requested moving them back to the top, +which has been done. See [release readiness](releases.md) for the later no-build audit. No new book deployment was performed during migration. Canvas Pilot publishes only its own book and badges; beffroi-tools retains ownership of the shared manuals landing page. Never synchronize/delete that shared root. diff --git a/docs/development/releases.md b/docs/development/releases.md index 458e864..f324af6 100644 --- a/docs/development/releases.md +++ b/docs/development/releases.md @@ -11,10 +11,56 @@ Review bundles on their target platforms before publishing a release. ```sh # Inspect the release plan without publishing. rust_realease . --package canvas-pilot --dry-run --stop-after inspect -# Build and package locally without creating a release. +``` + +## Lightweight readiness check + +```sh +rust_realease . --package canvas-pilot --dry-run +``` + +Unlike `--stop-after inspect`, the full dry run checks required metadata, build +prerequisites and the release tag. It does not compile, edit manifests, create tags +or publish. An exit failure for a missing tag is expected before release preparation. +`--compile-only` is **not** a lightweight check: it runs the actual builds and packages +artifacts. Run it later on a capable build host: + +```sh rust_realease . --package canvas-pilot --compile-only ``` +### Readiness audit — 2026-11-16 + +Checked with `rust_realease 0.1.6-rc.3`, without compiling or publishing: + +| Check | Result | +| --- | --- | +| Package/version and target plan | `canvas-pilot` 0.7.0; Linux, Windows, Apple Silicon and Intel macOS | +| Required cargo-binstall metadata | Added; matches the canonical `.tgz` archive layout | +| Portable bundle inputs | Icons, launcher scripts, MIT license and standalone quick-start file present | +| Cargo manifest/lock | Locked offline metadata inspection succeeds | +| Host prerequisites | Cross, cargo-binstall and a working Podman backend available | +| Apple image | Pinned registry manifest exists and its SHA-256 matches | +| Full dry run after metadata repair | Only reported prerequisite failure: missing `v0.7.0` tag | + +No release tag was created. Choose the intended release version, commit the final +sources, then explicitly prepare its matching tag on that commit when authorizing +a release. A publishing run requires a clean checkout. Use the configured Gitea +token environment variable or the tool's `--token-file` option; keep credentials +outside Git. No authenticated release creation/upload was exercised by this audit. + +This establishes configuration readiness, not successful cross-platform binaries. +Cross compilation, linker/SDK compatibility, packaged application startup and +post-upload cargo-binstall verification still require the actual build/release +workflow. Prior native tests are recorded in the handoff. The pinned Apple image +was not cached locally at this audit; its compressed layers total about 1,440 MiB +before any layer reuse. Image pulls and four target builds should run on a capable +host rather than as a quick check on an underpowered laptop. + +The portable archive uses `docs/canvas-pilot/portable-quickstart.txt` instead of the +repository README, so it does not depend on unbundled relative documentation links. +The canonical cargo-binstall archives remain separate from the named portable bundles. + For a local launcher after `cargo build --release --locked`: ```sh diff --git a/rust-release.toml b/rust-release.toml index 6261212..ea4835f 100644 --- a/rust-release.toml +++ b/rust-release.toml @@ -33,7 +33,7 @@ files = [ { source = "scripts/create-desktop-launcher.py", destination = "scripts/create-desktop-launcher.py", workspace-relative = true }, { source = "scripts/desktop_icons.py", destination = "scripts/desktop_icons.py", workspace-relative = true }, { source = "LICENSE", destination = "LICENSES/MIT.txt", workspace-relative = true }, - { source = "README.md", destination = "README.txt", workspace-relative = true }, + { source = "docs/canvas-pilot/portable-quickstart.txt", destination = "README.txt", workspace-relative = true }, ] [[repository.fallbacks]]