Repository navigation
docs: rewrite the README and project pages (players first) - #282
Merged
phantoslayer21 merged 9 commits intoNov 18, 2026
Merged
Conversation
What you need, install, tested games, Model L and Model K and problems come first; the developer overview links out to the detailed docs instead of repeating them. Every fact kept or moved (links and anchors checked). Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
Keeps the Borderlands 4 timing paragraph of phantoslayer21#281 word for word, so phantoslayer21#281 then this applies cleanly. Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
…statement The clean-room statement is byte-identical to main. Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
Preset K and the 0.6.1 heading are done; the open Hogwarts Legacy and RESIDENT EVIL items stay. Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
Same scope and contacts as before. Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
The tool versions are still the ones recorded for 0.6.0 (an open question in the pull request). Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
Every gate and step of main's text is kept. Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
Model K is converted from a DLSS file from one of the player's games, as the release notes say. Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.com>
It was first published as the 0.6.0 snapshot with one commit and no private history; it now carries 0.6.5. "Left out:" became "Not included:". Legal text: the maintainer should check these two sentences. Signed-off-by: Jonathan Shin <85975340+j0nsh1n@users.noreply.github.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.
Draft, as asked: the README and the project pages rewritten by Kimi K3.1 Pro, then checked against main (facts, links, anchors, legal wording) and corrected. One commit per file, so you can take some and leave others.
Files:
README.md,COMPATIBILITY.md,CONTRIBUTING.md,ROADMAP.md,SECURITY.md,BUILDING.md,RELEASING.md,docs/TESTING-OTHER-GAMES.md,docs/CLEAN-ROOM.md. Not touched:CODE_OF_CONDUCT.mdand the developer docs underclean/.What changed:
Please merge #281 first: this PR keeps its Borderlands 4 timing paragraph word for word, so #281 then this applies cleanly. The other order would conflict.
Open questions:
BUILDING.md, "Version used for 0.6.0") also the ones for 0.6.5? The issue templategame-compatibility-report.ymlalso still says "0.6.0's tested games" (not changed here).Checked: every relative link and anchor resolves;
git diff --checkandtools/ci/check_line_endings.pypass.reuse lintnot run locally.Checklist
Signed-off-by:line (DCO 1.1).REUSE.toml(no new files).