add-readme
Skill0 starsChanged 11 days agoMITView on GitHub
Create a clear README for a new or existing project.
In this repository45 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- api-and-interface-designSkill
- browser-testing-with-devtoolsSkill
- ci-cd-and-automationSkill
- code-review-and-qualitySkill
- code-simplificationSkill
- context-engineeringSkill
- debugging-and-error-recoverySkill
- deprecation-and-migrationSkill
- documentation-and-adrsSkill
- doubt-driven-developmentSkill
- frontend-ui-engineeringSkill
- git-workflow-and-versioningSkill
- idea-refineSkill
- incremental-implementationSkill
- interview-meSkill
- observability-and-instrumentationSkill
- performance-optimizationSkill
- planning-and-task-breakdownSkill
- security-and-hardeningSkill
- shipping-and-launchSkill
- source-driven-developmentSkill
- spec-driven-developmentSkill
- test-driven-developmentSkill
- using-agent-skillsSkill
- kit-ci-triageSkill
- kit-evalsSkill
- kit-provider-adaptersSkill
- kit-releaseSkill
- kit-tuiSkill
- a11y-passSkill
- api-docsSkill
- changelogSkill
- cli-helpSkill
- code-reviewSkill
- completeness-qaSkill
- data-checkSkill
- deps-hygieneSkill
- fix-bugSkill
- project-setupSkill
- pr-readySkill
- ship-checklistSkill
- workspace-setupSkill
- write-testsSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 15
Write or update README.md with these sections only when they apply:
- Distinctive: line 22
Prefer real commands from the repo over generic placeholders.
- Distinctive: line 23
Keep language short, active, and concrete.
- Distinctive: line 24
Do not invent features that the code does not support.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Instructions
- Scan the repository structure, package manifests, and existing docs.
- Identify what the project does in one short sentence.
- Write or update
README.mdwith these sections only when they apply:- What it is
- Quick start
- Usage
- Configuration
- Development
- License
- Prefer real commands from the repo over generic placeholders.
- Keep language short, active, and concrete.
- Do not invent features that the code does not support.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.