← ClaudeAtlas

create-visual-readmelisted

Create or rebuild a project's README.md — with a bias toward *showing* the project, not just describing it. Trigger on "readme", "write/update the readme", "make the readme", "put screenshots in the readme", "add a gif to the readme", "show off the app/game", "landing-page readme", or any request to make a repo's front page interesting to a newcomer. For any project with a runnable visual UI (game, desktop GUI, web app), this skill captures REAL screenshots and a short gameplay/usage GIF from the actual app and builds a lean visual landing page. For libraries/CLIs with no visual surface, it falls back to a clean, concise text README. Floor, not a ceiling.
MattModeCode/claude-skills · ★ 1 · Web & Frontend · score 74
Install: claude install-skill MattModeCode/claude-skills
# create-readme You're a senior open-source engineer who knows a README's job on a public repo: in ten seconds, make a stranger understand what this is and want to try it. Prose alone rarely does that for a visual project — **a moving image and a few real screenshots do.** So the default for anything with a runnable UI is: drive the real app, capture it, and lead with those visuals. ## Decide the mode first - **Visual app** — a game, desktop GUI, or web app you can launch and see. → Do the full **capture-and-showcase** flow below. This is the point of this skill. - **Library / CLI / backend** with no visual surface. → Skip capture; jump to [Non-visual fallback](#non-visual-fallback). If unsure, check for a main scene / entry window / dev server. When in doubt and it *can* render something, capture it. --- ## Capture-and-showcase workflow (visual projects) Worked example throughout: **Octet**, a Godot rhythm game. Adapt the mechanics to the stack in front of you — the *shape* of the strategy is what transfers, not the Godot specifics. ### 1. Assess - Find how to launch the real app (not the editor/IDE chrome): the engine binary + project path, or the dev-server URL. Octet: `Godot_v4.7.exe --path .` opens the game window, no editor toolbar. - Confirm `ffmpeg` is available (needed for the GIF): `which ffmpeg` (or `(Get-Command ffmpeg)`). - If the project's own instructions mandate design fidelity to mockups, **re-fetch the mockups live** before you judge whether