Skip to content

Add demo GIF to README#31

Merged
TimBeyer merged 10 commits intomainfrom
feat/readme-demo-gif
Mar 19, 2026
Merged

Add demo GIF to README#31
TimBeyer merged 10 commits intomainfrom
feat/readme-demo-gif

Conversation

@TimBeyer
Copy link
Owner

Summary

  • Embed an automated wizard demo GIF in the README, right after the quickstart section
  • Add scripts/record-demo.sh — a tmux + asciinema script that drives the wizard with scripted keystrokes and produces a clean .cast recording (converted to GIF with agg)
  • Add docs/demo-recording.md documenting how to re-record when the UI changes
  • Support NO_ALT_SCREEN env var in the create command to disable alternate screen buffer during recordings
  • Gitignore .cast files (intermediate artifacts, regenerated by the script)

Changes to README

The GIF appears between the quickstart command and the "what you get" list. Other README changes from an earlier redesign session are also included (collapsible command sections, GitHub callout syntax, nav bar, restructured features table).

Test plan

  • Review the GIF rendering on GitHub
  • Review README structure and flow
  • Verify scripts/record-demo.sh runs cleanly: ./scripts/record-demo.sh && agg docs/assets/demo.cast docs/assets/demo.gif

🤖 Generated with Claude Code

TimBeyer and others added 10 commits March 19, 2026 01:10
- Embed wizard demo GIF in README after quickstart section
- Add scripts/record-demo.sh (tmux + asciinema automated recording)
- Add docs/demo-recording.md documenting how to re-record
- Support NO_ALT_SCREEN env var in create command for clean recordings
- Gitignore .cast files (intermediate, regenerated by script)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Drop "The wizard walks you through everything" — the GIF shows it
- Remove hardcoded width, let GIF fill naturally
- Bump recording columns from 120 to 160 for wider output

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Longer provisioning screen (20s)
- Trim cleanup output from recording by content markers

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Collapsible sections hide content from scanning. These are things
users actively look for — keep them as headings, not details blocks.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Restore README from main and add the wizard demo GIF after quickstart.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add centered doc nav links under hero tagline
- Convert terminology note to GitHub [!NOTE] callout
- Simplify quickstart to single path (clawctl create)
- Remove redundant paragraph after "What you get" bullets

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove description paragraph that restated the tagline
- Separate Install and Quickstart into distinct sections
- Move terminology callout into Commands section
- Add headless mode cross-reference after quickstart
- Remove "run same command to update" note (auto-update now)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Replace Instance context subsection with a one-line summary
- Replace openclaw commands subsection with a TIP callout
- Remove Day-to-day management subsection (redundant with commands table)
- Keep Shell completions as the only subsection

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@TimBeyer TimBeyer merged commit 22e5630 into main Mar 19, 2026
4 checks passed
@TimBeyer TimBeyer deleted the feat/readme-demo-gif branch March 19, 2026 01:17
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