Skip to content

docs: rewrite the README and project pages (players first) - #282

Merged
phantoslayer21 merged 9 commits into
phantoslayer21:mainfrom
j0nsh1n:docs/readme-and-project-pages
Nov 18, 2026
Merged

phantoslayer21 merged 9 commits into
phantoslayer21:mainfrom
j0nsh1n:docs/readme-and-project-pages

Conversation

@j0nsh1n

@j0nsh1n j0nsh1n commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

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.md and the developer docs under clean/.

What changed:

  • README: players first (what you need, install, tested games, Model L and Model K, problems), then a shorter developer overview that links out to the detailed docs. About the same length (184 lines, 4 % fewer words); the gain is order and scanning, not size.
  • COMPATIBILITY: long table cells split into per-game sections.
  • BUILDING, RELEASING, TESTING-OTHER-GAMES: steps as lists and copyable command blocks; commands updated to 0.6.5.
  • CONTRIBUTING: the clean-room statement is byte-identical to main; the sentences around it are shorter.
  • CLEAN-ROOM: two sentences in "This repository" changed. The tree is no longer the one-commit 0.6.0 snapshot, so it now says it was first published that way and carries 0.6.5 now; "Left out:" became "Not included:". This is legal text you own: please check those two sentences.
  • No fact was dropped without moving it; nothing claims WrongGPU's output is the same as the original upscaler's; numbers keep their measurement.

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:

  • Can the Borderlands 4 timing run's Ray Reconstruction mode and WrongGPU version be identified?
  • Which release should own the remaining roadmap fixes?
  • Are the end-to-end compile-wait setup and the launcher compiler warnings still open?
  • Are the tool versions listed for 0.6.0 (BUILDING.md, "Version used for 0.6.0") also the ones for 0.6.5? The issue template game-compatibility-report.yml also still says "0.6.0's tested games" (not changed here).

Checked: every relative link and anchor resolves; git diff --check and tools/ci/check_line_endings.py pass. reuse lint not run locally.

Checklist

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>
@j0nsh1n
j0nsh1n marked this pull request as ready for review November 18, 2026 05:58
@phantoslayer21
phantoslayer21 merged commit 593dc6e into phantoslayer21:main Nov 18, 2026
10 checks passed
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.

2 participants