Skip to content

Comments

Redo README demo GIFs and document missing commands#10

Open
sderev wants to merge 2 commits intomainfrom
demo-gifs
Open

Redo README demo GIFs and document missing commands#10
sderev wants to merge 2 commits intomainfrom
demo-gifs

Conversation

@sderev
Copy link
Owner

@sderev sderev commented Feb 20, 2026

What changed

  • Replace GitHub-hosted demo GIFs with repo-local versions (assets/demos/*.gif) generated from asciicast recordings via agg
  • All demos now use the japanese:english pair consistently
  • Change add la casa example to add 猫 to match the demo pair
  • Rename "Generate an Anki deck" section to "Translate and generate an Anki deck"; add --count flag and anki alternative
  • Add "Estimate token usage" section for vocabmaster tokens
  • Document pairs default, config key, pair alias, and --pair
  • Explain ~/.config/lmt/key.env path (shared with lmterminal)
  • Remove duplicate translate GIF from the Anki deck section

Why

README demo GIFs were outdated: they showed the old setup command (now pairs add), used a spanish example inconsistent with the japanese hero GIF, and several CLI commands were undocumented.

How to test

  • Open the README on the branch and verify the 3 GIFs render and animate correctly
  • Confirm Japanese characters are legible in all GIFs
  • Check that no old GitHub asset URLs or obsolete commands (setup, add la casa) remain
  • Verify the new sections (tokens, pairs default, config key, pair alias, --pair, --count) match the actual CLI behavior: run each command with --help

Risk/compat notes

  • GIF paths are now repo-relative (assets/demos/*.gif); any external link pointing at the old GitHub asset URLs will still work (GitHub doesn't delete uploads) but the README itself no longer references them.

Changelog fragment

No. Documentation-only change — no user-visible behavior change.

sderev and others added 2 commits February 20, 2026 17:42
`assets/demos/generate_casts.py` builds asciicast v2 `.cast` files
with scripted typing and simulated CLI output for three demos:
`pairs add`, `add`, and `translate`. GIFs are rendered from the
casts with `agg` (Dracula theme, JetBrains Mono, japanese:english
pair).

The demos use japanese:english throughout for consistency with the
README hero GIF.

Co-authored-by: AI <ai@sderev.com>
Replace GitHub-hosted demo GIFs with repo-local versions generated
from asciicast recordings. All demos now use the japanese:english
pair consistently.

* Replace external GIF URLs with `assets/demos/*.gif` paths
* Change `add la casa` example to `add 猫` to match the demo pair
* Rename "Generate an Anki deck" section to "Translate and generate
  an Anki deck"; add `--count` flag and `anki` alternative
* Add "Estimate token usage" section for `vocabmaster tokens`
* Document `pairs default`, `config key`, `pair` alias, and `--pair`
* Explain `~/.config/lmt/key.env` path (shared with `lmterminal`)
* Remove duplicate translate GIF from the Anki deck section
* Drop "For detailed help" from the TOC

Co-authored-by: AI <ai@sderev.com>
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