Repository navigation
docs: short README and docs sorted into folders - #440
Merged
Merged
Conversation
Rewrite the README in the style of Lombyte's: OpenRAC logo, a short intro, progress (still written by tools/progress.py), supported versions, quick setup, credits and license. The SN tools download and container notes move to docs/build/building.md, the tracking rules to CONTRIBUTING.md, and how it works, tools and layout to docs/README.md. Sort every doc into docs/build, docs/contributing, docs/game, docs/research, docs/port and docs/agents, with lowercase names, and fix every link and path mention. The old rac2 logo goes: the README uses the OpenRAC logo.
assets/ in .gitignore also caught docs/assets, so the logo was never committed.
tools/progress.py no longer writes a table into the README: the per-version ByteMatch badges show the numbers, and the README needs no commit when progress moves.
ByteMatch progress reportSCES_516.07
No function changes. SCUS_972.68
No function changes. SCUS_972.68_v2
No function changes. Commit d1f57b5 · Ratchet & Clank: Going Commando on ByteMatch |
bigbeno37
added a commit
that referenced
this pull request
Nov 10, 2026
#440 changed the path in a comment that pad_div_erratum_nops.py writes into gas/config/tc-mips.c (docs/COMPILER-NOTES.md -> docs/build/compiler-notes.md) without updating the checksum tools/compiler/build.sh checks the patched source against, so the game compiler no longer built from scratch. The patched file with the old comment text hashes to the recorded b35ad5aa...; with the new text it is 3535b59f.... No code changes. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before
A long README with setup steps and hand-updated progress tables, and docs in one flat folder with mixed-case names.
After
A short README like Lombyte's: the OpenRAC logo with " decompilation project" under it, a code badge and a note for each version, quick setup, credits and license. Progress comes only from the ByteMatch badges, so the README needs no commit when progress moves. The details moved to docs/, now sorted into docs/build, docs/contributing, docs/game, docs/research, docs/port and docs/agents, with lowercase names and a docs/README.md index.
How
Files moved with git mv. Every link and path mention points to the new place. tools/progress.py no longer writes a table into the README. The SN tools download and container notes move to docs/build/building.md, the tracking rules to CONTRIBUTING.md. The old rac2 logo is removed; docs/assets is unignored for the OpenRAC logo.
Tested
tests/check_repository.py and tools/progress.py --check pass; the unit tests fail the same 7 rabbitizer imports as master. The build was not run (no disc in the container). Relative Markdown links checked with a link checker.