Skip to content

README: state requirements up front, adverb pass - #21

Merged
phucnht merged 3 commits into
mainfrom
develop
Aug 20, 2026
Merged

README: state requirements up front, adverb pass#21
phucnht merged 3 commits into
mainfrom
develop

Conversation

@phucnht

@phucnht phucnht commented Aug 20, 2026

Copy link
Copy Markdown
Owner

Documentation only. Cuts two empty uses of "normally" (one genuinely meaningless, one meant "without running latexdiff" and now says so), trims two doubled words, and moves the supported-engines/TeX-Live-floor line from Development to Installation, where someone deciding whether to use the package actually looks. Full reasoning in #20.

A Sponsor button was drafted and then held back on request; nothing here touches funding.

Three changes to the README plus a funding file.

"Then load it normally" invited the question it was meant to answer:
there is no abnormal way to load a package, so the word is cut. A second
"normally" further down did carry meaning, badly, since it meant
"without running latexdiff"; it now says that. Two doublings go with
them: a purpose clause already carried the intent that "deliberately"
repeated, and "remains" already carries the permanence that "always"
repeated.

The remaining adverbs stay. Each was checked in context and each is
doing work: the two restrictive uses of "only", "permanently"
distinguishing the reversible CLI mode from the irreversible one,
"intentionally" pre-empting a bug report about skipped content in the
Limitations section, and two concessive uses of "still".

The supported engines and the TeX Live floor were stated only inside the
Development section, describing what the test suite covers. Someone
deciding whether the package works for them reads Installation, so the
claim now appears there. It matches what CI actually runs: pdfTeX, XeTeX
and LuaTeX across TeX Live 2023, 2024, 2025 and the current release.

FUNDING.yml is per-repository rather than a phucnht/.github default,
because almost every other public repository on the account is a fork of
someone else's project and a default would risk soliciting sponsorship
on their work. The README carries a sponsor line as well, since readers
who arrive through CTAN or the documentation site never see the button.
Not ready to turn it on. The dashboard (tiers, profile) gets set up
first; the FUNDING.yml and README section come back as a small PR
whenever asked. Everything else this branch changed (the adverb pass,
the Installation requirements line) stays.
README: state requirements up front, adverb pass
@phucnht
phucnht merged commit 0f22362 into main Aug 20, 2026
14 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.

1 participant