Menu

Individual skill

ai-readme

0upvotes

Create or substantially revise repository README files that help a specific reader understand a technical project, reach a verified first result, and progress into realistic use, evaluation, debugging, or contribution. Use for project landing READMEs, CLI and library quickstarts, experimental or research repositories, executable engineering notebooks, and contributor-facing repository guides when an agent should reconstruct behavior from code, tests, commands, examples, and history rather than write generic documentation.

ai-readme/SKILL.md

Read pinned source

Source commit 1acf58f08cca24b764a4352a6c30fed1f7fb9fb6

What was checked

Matches the observed repository HEAD
Yes
Scanner rules are current
Yes
Repository scan complete
No
Skill scan complete
No
Observed behavior
Instructions only
Last checked
Nov 11, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings)
198
Repository last updated
Nov 9, 2026
License
MIT

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files
Read excerpt

# AI README

Write a repository-native explanation that earns trust by working. Lead with
what the project is, who it helps, and the shortest verified path to an
observable result. Then reveal the mechanism, tradeoffs, diagnostics, and
internals at the reader's pace.

Combine two complementary habits:

- use an executable, progressive spine: one stable example, working commands,
  expected results, controlled variants, visible failure modes, and a reference
  path when correctness or quality can vary;
- write like a public technical notebook: begin from a real task or curiosity,
  show the decisive artifact near the claim, explain what happened in ordinary
Back to top