Skip to content

docs: refine README#4

Merged
rrbe merged 9 commits intomasterfrom
docs-refine
Apr 20, 2026
Merged

docs: refine README#4
rrbe merged 9 commits intomasterfrom
docs-refine

Conversation

@rrbe
Copy link
Copy Markdown
Owner

@rrbe rrbe commented Apr 20, 2026

No description provided.

rrbe and others added 9 commits April 20, 2026 23:15
Adds install.sh and uninstall.sh at the repo root so users can install
via `curl ... | bash`. Scripts detect OS/arch, verify the archive's
SHA-256 against SHA256SUMS, never invoke sudo, and honor
TERMDOWN_VERSION / TERMDOWN_INSTALL_DIR overrides. Release workflow
uploads both as release assets. READMEs (EN + CN) document the new
flow with the manual curl+tar commands preserved under <details>.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Strip the explanatory prose around the install and uninstall
one-liners in both READMEs; keep only the command and a terse note
about overridable env vars. Full details remain in the script itself
and in the collapsed manual-install fallback.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
install.sh always pulls the latest release — the TERMDOWN_VERSION
override was speculative (YAGNI). Source-install section in both
READMEs shrinks to a single `cargo install --git <url>` line; the
clone + cargo-install + manual cp variants were redundant with the
install-script flow and the cargo invocation violated the project's
"build via Makefile" rule anyway.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Inserts a two-column HTML table with the two demo screenshots
(docs/screenshots/) right after the tagline in both READMEs, forcing
a reliable side-by-side layout on GitHub (<p align=center> gets its
align attribute stripped). Width 380 per image keeps 2x380=760px
under a narrow README content column.

Also syncs a handful of English phrasings to match the Chinese
source: # Flags -> # View help, shorter [font.heading] comments, and
a terser note on standalone-emoji font fallback.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@rrbe rrbe merged commit 13f36cb into master Apr 20, 2026
5 checks passed
@rrbe rrbe deleted the docs-refine branch April 20, 2026 16:52
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