README: put a Download section with per-platform installers at the top (#411)
Badges and one-line instructions for Windows, macOS, Linux and the web app, right after the tagline and demo. The links use releases/latest/download with version-less file names, which release.yml now attaches (and checksums) alongside the versioned installers. The Flatpak note and the name/compatibility section move into the book's Getting started page. Claude-Session: https://claude.ai/code/session_01RjGw4gA5ZvKrU8MQP6sBgT Co-authored-by: Claude Opus 5.5 <[email protected]>
This commit is contained in:
1 parent
296683229d
commit
e56e055fa1
5 files changed
+88
-18
No files matched your search
@@ -6,7 +6,8 @@ working (see the [compatibility notes](https://github.com/bherbruck/solidcraft/b
|
||||
|
||||
## Desktop
|
||||
|
||||
Download the latest build from the
|
||||
Download the installer for your system from the
|
||||
[Download section of the README](https://github.com/bherbruck/solidcraft#download) or the
|
||||
[releases page](https://github.com/bherbruck/solidcraft/releases), or build it yourself with
|
||||
stable Rust (1.95 or newer):
|
||||
|
||||
@@ -89,3 +90,15 @@ A script is a list of commands:
|
||||
|
||||
Units are millimetres and degrees unless an expression says otherwise (`"1 in"`, `"30 deg"`),
|
||||
and Z is up.
|
||||
|
||||
## Name and compatibility
|
||||
|
||||
SolidCraft was renamed from an earlier working name. Since 0.5.0 everything uses the new
|
||||
name: the `solidcraft` and `solidcraft-cli` programs, `.solidcraft` designs, `SOLIDCRAFT_*`
|
||||
environment variables, settings folders and the `solidcraft` MCP server. Upgrading keeps
|
||||
working: designs, settings, recovery files, environment variables and CLI/MCP setups from
|
||||
earlier builds carry over. Every compatibility shim is listed in the
|
||||
[compatibility notes](https://github.com/bherbruck/solidcraft/blob/main/docs/compatibility.md).
|
||||
|
||||
Use the SolidCraft documentation and web-app URLs. GitHub redirects links to the renamed
|
||||
repository; old-name Pages and Flatpak URLs are not maintained as permanent aliases.
|
||||
@@ -15,6 +15,13 @@ Every release asset, binary, installer product name and package uses the SolidCr
|
||||
copies, the deprecated old-name CLI alias); keep them until that document says they can go. Do not
|
||||
rewrite published assets, checksums, tags or historical release notes of earlier versions.
|
||||
|
||||
The main installers (`.msi`, portable `.zip`, `.dmg`, `.AppImage`, `.deb`, `.rpm`, `.flatpak`) are
|
||||
also attached without the version in their names, for example `solidcraft-windows-x64.msi` and
|
||||
`solidcraft-linux-x86_64.AppImage`, and listed in `SHA256SUMS.txt`. The README's Download section
|
||||
links to `https://github.com/bherbruck/solidcraft/releases/latest/download/<name>`, which follows
|
||||
the release marked latest; nightlies never are. Keep these names stable: renaming one breaks the
|
||||
README links.
|
||||
|
||||
Project Pages publishes the documentation, browser app and published-release Flatpak
|
||||
repository under `/solidcraft/`. Do not add a separate owner-site publisher or permanent
|
||||
old-name Pages/Flatpak aliases. GitHub repository redirects are separate from Pages hosting;
|
||||
|
||||
Reference in new issue
Block a user