Skip to content

docs: make the README ours and move bolrog's changelog to docs/ - #18

Merged
jackrayner merged 3 commits into
mainfrom
docs/readme-fork
Oct 24, 2026
Merged

jackrayner merged 3 commits into
mainfrom
docs/readme-fork

Conversation

@jackrayner

Copy link
Copy Markdown
Owner

First pass at making the README the fork's own: only what is wrong or misleading today, plus the changelog split. A larger restructure (compatibility table, configuration doc, CONTRIBUTING) comes later.

README

  • Removed: the upstream strawpoll, the July 2021 "too busy" note, and bolrog's donation link.
  • Added a short fork notice (maintained fork, not intended to be merged back), "Fork maintenance: Jack Rayner", and a missing credit for tomlc99 (it is in thirdparty/ and its licence ships in the zip).
  • Installation points at the latest release. The Visual C++ runtime note is gone: the DLL is statically linked and imports only system DLLs (CI fails if that changes).
  • Requirements: Windows 7/8.1 are noted as untested with this fork's build.
  • Wiki links now say they describe upstream and may be out of date. The "file an issue" line no longer points at an Issues tab that is disabled; it points at DEVELOPMENT.md and asks for d2dx_log.txt.
  • The "Recent release history" block (about 140 of 236 lines) moved to docs/upstream-changelog.md with an attribution header. All 31 version entries are preserved. The README links to it and to CHANGELOG.md using absolute URLs, since only the README ships in d2dx.zip.

Releases: removed prerelease: true from release-please-config.json; AGENTS.md now says releases state in their notes what was tested, and a release can be marked prerelease by hand.

Not in this PR: DEVELOPMENT.md (it is changed in the open tracker PR; I will add the follow-up rows after that merges), enabling Issues, the compatibility table and other new docs.

🤖 Generated with Claude Code

jackrayner and others added 3 commits October 24, 2026 15:19
Remove the upstream poll, the 2021 'too busy' note and bolrog's donation link;
replace the stale Visual C++ runtime note (the DLL is statically linked and CI
enforces it); point installation at the latest release; add the fork notice,
fork maintainer and tomlc99 credits; and move the 0.99.x release history out of
the README (it ships in d2dx.zip) into docs/upstream-changelog.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
0.0.1 has been played in the game, so the config no longer forces the flag.
Releases state in their notes what was and wasn't tested.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Latest release, Tests, CodeQL and licence.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@jackrayner
jackrayner merged commit b8fd0b7 into main Oct 24, 2026
4 checks passed
@jackrayner
jackrayner deleted the docs/readme-fork branch October 24, 2026 14:29
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.

1 participant