From 4ea3be69ba502f4f2895dde3369c9010323ecb82 Mon Sep 17 00:00:00 2001 From: Phuc Nguyen <16951671+phucnht@users.noreply.github.com> Date: Thu, 20 Aug 2026 09:08:03 +0700 Subject: [PATCH 1/2] docs: state the requirements up front, and add a sponsor button 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. --- .github/FUNDING.yml | 6 ++++++ README.md | 14 ++++++++++---- 2 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..5bb5e9f --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,6 @@ +# Shown as the Sponsor button on this repository. +# +# Deliberately per-repository rather than a phucnht/.github default: almost +# every other public repository on this account is a fork of someone else's +# project, and a default would risk soliciting sponsorship on their work. +github: phucnht diff --git a/README.md b/README.md index df65e8e..55a5b13 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,15 @@ Compared to the `changes` package, texchanges adds review decisions (`pending`/` ## Installation +Texchanges runs on pdfTeX, XeTeX, and LuaTeX, and needs no packages beyond a TeX Live installation. Every release is verified against TeX Live 2023, 2024, 2025, and the current release. + Texchanges is on [CTAN](https://ctan.org/pkg/texchanges) and distributed through TeX Live: ```bash tlmgr install texchanges ``` -Then load it normally: +Then load it: ```latex \usepackage[review]{texchanges} @@ -111,7 +113,7 @@ Presets are `texchanges`, `default`, `underlined`, `bfit`, and `nocolor`. - Comment styles: `inline`, `todo`, `margin`, `footnote`, and `uwave`. - Author styles: `superscript`, `subscript`, `brackets`, `footnote`, and `none`. -Additions, removals, and highlights render in the author's registered color. Replacements deliberately use the fixed removed/added palette so the old and new text stay distinguishable within one change; the author label still carries the author's color. +Additions, removals, and highlights render in the author's registered color. Replacements use the fixed removed/added palette so the old and new text stay distinguishable within one change; the author label still carries the author's color. Runtime hooks such as `\txsetaddedmarkup`, `\txsetcommentmarkup`, `\txsetauthormarkup`, and the width/auxiliary-file setters are documented in the [online API reference](https://texchanges.dev/reference/api/). @@ -126,7 +128,7 @@ Compatibility is opt-in because replacement arguments use the opposite order: \replaced[id=phuc,changeid=R12]{new text}{old text} ``` -Use `commandnameprefix=none|ifneeded|always` for compatibility commands. Native `\txreplace` always remains `old` then `new`. +Use `commandnameprefix=none|ifneeded|always` for compatibility commands. Native `\txreplace` remains `old` then `new` in every mode. ## Resolve source markup @@ -145,7 +147,7 @@ In-place updates create a `.bak` file. Interactive mode, nested braces, Unicode, ## Automatic `latexdiff` -`examples/automatic-diff/` compares `texchanges-original.tex` and `texchanges-revised.tex` through Overleaf's `latexmkrc` mechanism, with `texchanges-review.tex` as the Main document. It uses word-level matching, so short shared phrases remain unchanged. The same `latexmkrc` compiles `texchanges-explicit-review.tex` normally when that document is selected as Main. +`examples/automatic-diff/` compares `texchanges-original.tex` and `texchanges-revised.tex` through Overleaf's `latexmkrc` mechanism, with `texchanges-review.tex` as the Main document. It uses word-level matching, so short shared phrases remain unchanged. The same `latexmkrc` compiles `texchanges-explicit-review.tex` directly, without running `latexdiff`, when that document is selected as Main. Run `make dist` to build the single `dist/texchanges-overleaf.zip` upload bundle. Its [workflow guide](examples/overleaf-workflow/README.md) explains both Main-document choices. @@ -175,6 +177,10 @@ The suite covers all modes, metadata, reports, styles, compatibility syntax, the Bug reports and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for where to start, how to run the suite, and the compatibility rules. Report issues at . +## Sponsor + +Texchanges is free and stays free. If it saves you time, [sponsoring its development](https://github.com/sponsors/phucnht) helps keep it maintained. + ## Limitations - Complex display math, floats, headings, verbatim content, and some commands should be changed at a larger text boundary or reviewed with `latexdiff`. From b6c372a140c4fba2fe8e17c1f0e3bd3c514e156e Mon Sep 17 00:00:00 2001 From: Phuc Nguyen <16951671+phucnht@users.noreply.github.com> Date: Thu, 20 Aug 2026 12:05:44 +0700 Subject: [PATCH 2/2] revert: hold the Sponsor button on texchanges for now 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. --- .github/FUNDING.yml | 6 ------ README.md | 4 ---- 2 files changed, 10 deletions(-) delete mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 5bb5e9f..0000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,6 +0,0 @@ -# Shown as the Sponsor button on this repository. -# -# Deliberately per-repository rather than a phucnht/.github default: almost -# every other public repository on this account is a fork of someone else's -# project, and a default would risk soliciting sponsorship on their work. -github: phucnht diff --git a/README.md b/README.md index 55a5b13..fc655ac 100644 --- a/README.md +++ b/README.md @@ -177,10 +177,6 @@ The suite covers all modes, metadata, reports, styles, compatibility syntax, the Bug reports and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for where to start, how to run the suite, and the compatibility rules. Report issues at . -## Sponsor - -Texchanges is free and stays free. If it saves you time, [sponsoring its development](https://github.com/sponsors/phucnht) helps keep it maintained. - ## Limitations - Complex display math, floats, headings, verbatim content, and some commands should be changed at a larger text boundary or reviewed with `latexdiff`.