← ClaudeAtlas

beginner-readme-sectionlisted

Adds a "New to this? Start here" section to the top of a project's README, written for someone who has never used the project - who it is for, the problem it solves, four steps, one sentence to type to Claude, and what comes back. The "what you get back" part is only ever real output from actually running that sentence; if it could not be run, the section says so. Use when the user asks to add a beginner section, a start-here section or a quick start for newcomers to a README, for example "add a beginner section to my README", "README에 초보용 칸 만들어 줘", "make my README beginner friendly".
vivaminima/beginner-readme-section · ★ 0 · Data & Documents · score 72
Install: claude install-skill vivaminima/beginner-readme-section
# Beginner README Section Write one short section at the top of the README that gets a first-time reader from "what is this" to a real result. Change nothing else in the README. ## When to use - The user asks for a beginner section, a "start here" section, or a newcomer quick start in a README. - The user says the README is hard for new people to follow. Do not use it to rewrite or restructure the whole README, and do not use it for API reference or contributor docs. ## Steps 1. **Read the project.** Read the README, the top-level file list, and the entry point (the main script, the skill file, or the command the README tells people to run). Find out what a person actually does with this project and what they get. 2. **Find the sample.** Look for a sample or example folder the project ships (`examples/`, `sample/`, `demo/`, test fixtures). The beginner steps must work on something that is already in the repository. If there is nothing to run the project on, tell the user and ask whether to add a small sample; do not invent one silently. 3. **Choose the one sentence.** Write the single sentence a beginner would type to Claude to get the project's main result on the sample. Use the user's own words where the README has them. One sentence, no options, no flags. 4. **Run it for real.** Do exactly what that sentence asks, on the sample, the way a newcomer's Claude would: run the command or follow the skill. Capture what comes back. Work on a copy if running it changes files.