README: state requirements up front, adverb pass - #20
Merged
Conversation
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.
phucnht
changed the title
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
1 participant
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.
The adverb pass
Started from one word and swept the rest rather than assuming. Most of the adverbs in the README turned out to be load-bearing, so this is a small edit, not a strip.
Cut:
normallytwice. At line 25 it invited the question it was meant to answer, since there is no abnormal way to load a package. At line 148 it did carry meaning, badly: it meant "without runninglatexdiff", which it now says.Trimmed: two doublings.
deliberatelyrepeated intent that the following purpose clause already carried, andalways remainsrepeated permanence thatremainsalready carries.Kept, each checked in context:
only×2permanentlyintentionallystill×2latexdiffif the markup lives in the source?"No em dashes, no hard-wrapped prose, no inflated adjectives, no
very/simply/just/basically.Requirements were in the wrong section
Supported engines and the TeX Live floor appeared only at line 172, inside Development, describing what the test suite covers. Someone deciding whether the package works for them reads Installation. The claim now appears there, and it matches what CI actually runs: pdfTeX, XeTeX and LuaTeX across TeX Live 2023, 2024, 2025 and the current release.
Suite green at 22 cases.
A Sponsor button (
.github/FUNDING.yml+ README section) was in an earlier version of this PR and has been reverted for now; the dashboard gets set up first.