Skip to content

README: features first, a contributing guide and code owners - #107

Merged
gascarcella merged 2 commits into
mainfrom
gascarcella/readme-update
Oct 24, 2026
Merged

gascarcella merged 2 commits into
mainfrom
gascarcella/readme-update

Conversation

@gascarcella

@gascarcella gascarcella commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

What

  • README.md restructured with headers and sub-headers for permalinks:
    1. the opening paragraph (unchanged);
    2. Features, by area (runtime, rendering, sound and input, the Psy-Q shim, launcher and in-game menu, mods, build/platforms/tools), each pointing at its doc;
    3. Contents, a table of contents;
    4. Using it from a game: what a game provides, adding the stack, building the port and the launcher, versions and releases;
    5. Developing: setup, tests, layout, docs, contributing;
    6. Background: the status (now v0.3.16, the release notes as a list) and how it got here;
    7. License.
  • CONTRIBUTING.md: the ground rules (no game code/data/SDK, no game facts, the contract first, reproducible), setup, branch and pull request, the gates, docs, naming, commits, releases.
  • .github/CODEOWNERS: * @gascarcella; added to CI's paths-ignore (ci.yml, CLAUDE.md, CONTRIBUTING.md say so).

Gates

Documentation only: no tests run. .github/CODEOWNERS joins CI's paths-ignore (with Markdown and LICENSE), so a change to it alone runs nothing; this pull request's own runs (started by the ci.yml edit) were cancelled.

🤖 Generated with Claude Code

gascarcella and others added 2 commits October 24, 2026 20:18
…ontributing guide and code owners

The README opens with what the stack bundles (Features, by area, each pointing at its doc), a table of contents,
how a game uses it, and a Developing section (setup, tests, layout, docs, contributing); the history moves to the
end and the status is v0.3.16. CONTRIBUTING.md gives the ground rules, the gates and the pull request steps;
.github/CODEOWNERS names the owner as reviewer.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…and LICENSE

No step reads it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@gascarcella
gascarcella merged commit 5dfa7dd into main Oct 24, 2026
@gascarcella
gascarcella deleted the gascarcella/readme-update branch October 24, 2026 23:20
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