mirror of
https://github.com/jkdansereau/goldeneye-pc-port.git
synced 2026-10-23 15:52:42 +02:00
James Dansereau
4ca11e4386
- README: attract-mode stills + demo GIF as the hero row, status/warning callouts, metrics table, "Contents" index, doc-index table; simplified the two-agent workflow diagram (LR -> TD, fewer edges) for GitHub web - Table-of-contents indexes added to internals.md, porting-notes.md, agentic-development.md, AUDIO-PLAN.md - CI: add Windows/MSYS2 build job, minimal token (contents: read), persist-credentials: false, concurrency group; run on main + master. validate job regenerates the US ROM-asset symbol file only and configures ntsc-final (PAL/JP need a region ROM; no ROM is used in CI) - .github: SECURITY.md, issue forms + chooser config, PR template, labels.yml, dependabot (Actions, monthly) - Do not track the proprietary SGI IRIX IDO toolchain or SGIImageViewer.exe; document in SetupGuide.md / building.md how to obtain IDO for N64 ROM builds (the PC port does not need it) - Stop tracking two committed *.pyc files; drop stale screenshots and a redundant .gitignore line; misc doc cross-reference fixes Claude-Session: https://claude.ai/code/session_01GULf6knbsqfsnW39tMr9WT
38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
<!--
|
|
Read CONTRIBUTING.md first. This is a faithfulness-focused port; the ground
|
|
rules there are non-negotiable.
|
|
-->
|
|
|
|
## What this changes
|
|
|
|
<!-- One or two sentences. Link the issue it closes: "Closes #123". -->
|
|
|
|
## Why
|
|
|
|
<!-- The reasoning, not just the diff. What was wrong / missing? -->
|
|
|
|
## Scope check
|
|
|
|
- [ ] No changes under `src/` or `include/` — **or** the only changes are the
|
|
narrow `#ifdef PORT` ABI exception (CONTRIBUTING.md rule 2), and each is
|
|
documented in `docs/porting-notes.md` / `docs/dev/findings.md`.
|
|
- [ ] `Makefile`, `tools/`, `rsp/`, `ld/` untouched (N64 build).
|
|
- [ ] If `CMakeLists.txt` `REGION_DEFS` changed, it still matches the N64
|
|
`Makefile` per-region macro set exactly.
|
|
|
|
## Verification
|
|
|
|
<!-- What you actually ran. Delete lines that don't apply. -->
|
|
|
|
- [ ] `./build-pc.sh ntsc-final` — clean configure + link
|
|
- [ ] Crash-free run of at least one level (`-level_09`)
|
|
- [ ] Single-frame `GE_PCDUMP` diff against the committed golden — no
|
|
unexpected change
|
|
- [ ] pal-final / jpn-final also configured
|
|
|
|
Platform tested: <!-- e.g. Windows 10 / MSYS2 MINGW64 -->
|
|
|
|
## Notes for the reviewer
|
|
|
|
<!-- Anything uncertain, follow-ups, or areas that need a closer look. -->
|