Skip to content

docs: give the readme a front page and compose the release notes - #62

Merged
Mastersam07 merged 4 commits into
devfrom
docs/release-notes
Sep 24, 2026
Merged

Mastersam07 merged 4 commits into
devfrom
docs/release-notes

Conversation

@Mastersam07

@Mastersam07 Mastersam07 commented Sep 24, 2026 •

Copy link
Copy Markdown
Owner

What: Two pieces of the same job, presenting the project to someone who has never seen it.

The release body carried only the changelog section. It now also states the
requirements, the known gaps, how to verify the download, who to credit and where
to report a bug, with the gaps read from the readme so they cannot drift.

Composing them is its own step so that a failure stops the job before a tag or a
release exists, rather than inside a process substitution whose exit status
nothing checks.
The icon, one line saying what it is, a place for a screenshot and a download
button, following the shape of the prior art's own front page.

Adds a section on sharing a machine with Device Hub, including the two Apple
preferences that stop it opening and stop it taking simulators down when it
quits, and says plainly that nothing can take over the app Xcode launches.

Also replaces every em dash in the readme and the roadmap, which no tracked file
should carry.
@Mastersam07 Mastersam07 changed the title docs: compose the release notes from the changelog and the readme docs: give the readme a front page and compose the release notes Sep 24, 2026
Location scenarios, custom coordinates, creating and erasing a simulator, text
size and increased contrast all ship now, so the roadmap was listing them as
missing. Each entry keeps only what is genuinely left.
@Mastersam07
Mastersam07 merged commit 8d8ab6d into dev Sep 24, 2026
2 checks passed
@Mastersam07
Mastersam07 deleted the docs/release-notes branch September 24, 2026 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant