Repository navigation
docs: short README and docs sorted into folders - #143
Merged
Merged
Conversation
Rewrite the README in the style of Lombyte's: OpenRAC logo, a short intro, the progress tables (still written by tools/progress.py), supported versions with a code badge each, quick setup, credits and license. The badges by part and by level move to docs/build/progress.md, the full setup to docs/build/building.md. Sort every doc into docs/build, docs/contributing, docs/agents and docs/history (notes/ included), with lowercase names, and fix every link and path mention.
assets/ in .gitignore also caught docs/assets, so the logo was never committed.
tools/progress.py no longer writes or checks tables in the README: the per-version ByteMatch badges show the numbers, and the README needs no commit when progress moves. It still prints the tables.
ByteMatch progress reportSCES_532.85
No function changes. SCUS_974.65
No function changes. Commit c7b6f0f · Ratchet: Deadlocked on ByteMatch |
farfeduc
added a commit
to farfeduc/rac4-decomp
that referenced
this pull request
Nov 10, 2026
Co-Authored-By: Claude <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/agents and docs/history (with the old notes/ folder), 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 or checks README tables (it still prints them). The badges by part and by level move to docs/build/progress.md. docs/assets is unignored for the OpenRAC logo.
Tested
tools/progress.py --check passes for us and pal; the unit tests fail the same 2 elftools imports as main. The build was not run (no disc in the container). Relative Markdown links checked with a link checker.