Skip to content

Shorter README with 0.2.2 images and tour - #167

Merged
rndaom merged 4 commits into
mainfrom
rndaom/readme-refresh
Oct 2, 2026
Merged

rndaom merged 4 commits into
mainfrom
rndaom/readme-refresh

Conversation

@rndaom

@rndaom rndaom commented Oct 2, 2026

Copy link
Copy Markdown
Owner

What changed

The README was a long feature list with 0.2.0 media. It now leads with what players need:

  • Header and install images drawn in the app's style with tools/promo (pnpm readme): the wordmark and tagline beside the TF2 emblem in dots, and the two SmartScreen steps (More info → Run anyway) without a version-specific file name.
  • Shorter text: what execs does, what's new in 0.2.2, four screenshots of the key pages (Profiles, Crosshair, Sounds, Inventory), install, help and credits. It's 739 words instead of 1,675.
  • Install details moved to the guide: checking the download, Linux notes, where files live, uninstalling and troubleshooting are in the new docs/guide/install.md, linked from the README and the guide index.
  • New tour GIF: re-recorded from the current app. The Crosshair scene uses the new gallery and true-size preview, Sounds opens on the game and music volume sliders, the recap shows six 0.2.2 features, and the outro reads the version from the app's package.json.

The six screenshots the README no longer uses are removed.

Capture fixes

The recorder had drifted from the app: the preview's launch-options and High preset anchors changed, and saving a profile now opens the welcome tour, which the capture skips. gif.mjs also passes Remotion a relative frame folder, because Remotion rejects an absolute output path whose parent folders contain a dot.

Checks

  • biome check . and the promo's tsc --noEmit
  • Test stills of the Crosshair, Sounds, recap and outro frames, then the full 1,650-frame GIF (19.7 MB, the same size as the previous one)

rndaom added 4 commits October 2, 2026 08:43
The README listed every feature and screenshot. It now says what execs does,
what's new in 0.2.2, four key screens and how to install. Checking the
download, data locations, uninstalling and troubleshooting move to a new
Installing and removing guide page.
Two new promo stills, rendered with pnpm readme: a header with the
wordmark and the TF2 emblem in dots, and the two SmartScreen steps that
the September 24 wording review removed, redrawn without the old file name
or the claim about why the installer is unsigned.
The tour GIF showed the 0.2.0 Crosshair pane and listed what was new in
0.2.0. It is re-recorded from the current app: the Crosshair scene clicks
one of TF2's crosshairs and two execs shapes beside the true-size preview,
Sounds opens on the game and music volume sliders, the recap shows six
0.2.2 features, and the outro reads the version from the app's package.

The README keeps four screenshots of the key pages (Profiles, Crosshair,
Sounds, Inventory); the other six are removed.

Capture fixes for the current app: the preview's launch-options and High
preset anchors changed, saving a profile now opens the welcome tour (the
capture skips it), and gif.mjs passes Remotion a relative frame folder
because it rejects absolute output paths whose parents contain a dot.
@rndaom
rndaom merged commit 28b2ade into main Oct 2, 2026
9 checks passed
@rndaom
rndaom deleted the rndaom/readme-refresh branch October 2, 2026 14:46
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