Agent skill

Readme Generator

Creates or updates the GitHub README for a textbook project with badges, project overview, site metrics, and getting-started instructions.

CC-BY-NC-4.0Auto-check passedDevelopment

Install Readme Generator

skills CLI

$ npx skills add dmccreary/ibook-skills --skill readme-generator -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install dmccreary/ibook-skills readme-generator --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/dmccreary/ibook-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/archived/readme-generator .claude/skills/readme-generator && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "readme-generator" agent skill from https://github.com/dmccreary/ibook-skills/tree/main/skills/archived/readme-generator into .claude/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/dmccreary/ibook-skills/tree/main/skills/archived/readme-generator

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add dmccreary/ibook-skills --skill readme-generator -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install dmccreary/ibook-skills readme-generator --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/dmccreary/ibook-skills.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/archived/readme-generator .agents/skills/readme-generator && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "readme-generator" agent skill from https://github.com/dmccreary/ibook-skills/tree/main/skills/archived/readme-generator into .agents/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add dmccreary/ibook-skills --skill readme-generator -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install dmccreary/ibook-skills readme-generator --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/dmccreary/ibook-skills.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/archived/readme-generator .cursor/skills/readme-generator && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "readme-generator" agent skill from https://github.com/dmccreary/ibook-skills/tree/main/skills/archived/readme-generator into .cursor/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/dmccreary/ibook-skills.git --path skills/archived/readme-generator

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add dmccreary/ibook-skills --skill readme-generator -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install dmccreary/ibook-skills readme-generator --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/dmccreary/ibook-skills.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/archived/readme-generator .gemini/skills/readme-generator && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "readme-generator" agent skill from https://github.com/dmccreary/ibook-skills/tree/main/skills/archived/readme-generator into .gemini/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install dmccreary/ibook-skills readme-generator

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add dmccreary/ibook-skills --skill readme-generator -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/dmccreary/ibook-skills.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/archived/readme-generator .github/skills/readme-generator && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "readme-generator" agent skill from https://github.com/dmccreary/ibook-skills/tree/main/skills/archived/readme-generator into .github/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add dmccreary/ibook-skills --skill readme-generator -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install dmccreary/ibook-skills readme-generator --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/dmccreary/ibook-skills.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/archived/readme-generator .opencode/skills/readme-generator && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "readme-generator" agent skill from https://github.com/dmccreary/ibook-skills/tree/main/skills/archived/readme-generator into .opencode/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: readme-generator
GitHub stars: 105
Token cost: ~4.9k tokens
SKILL.md length: 1,466 words
Files: 5 (incl. scripts, references)
Skills in repo: 32
Repo updated: Oct 9, 2026
First seen: Oct 7, 2026
Licence: CC-BY-NC-4.0

At a glance

Creates or updates the GitHub README for a textbook project with badges, project overview, site metrics, and getting-started instructions.

Works in 12 steps: Analyze Repository Context → Generate Badges → Add License Badge → …
Tasks that involve Technical documentation
SKILL.md covers Purpose, When to Use This Skill, Workflow and Supporting Scripts, plus 4 more sections
Runs Python scripts from its folder; calls python3, pip and python; reaches img.shields.io and github.com

What it does

Readme Generator is an agent skill from dmccreary/ibook-skills. Creates or updates the GitHub README for a textbook project with badges, project overview, site metrics, and getting-started instructions.

Its SKILL.md is about 4.9k tokens, which your agent loads only when the skill is triggered. The skill folder holds 6 other files, including scripts and reference files (for example `README.md`, `references/badges.md` and `scripts/collect-site-metrics.py`).

It sits in Development, covering Technical documentation. It works with GitHub.

When your agent uses it

Tasks that involve Technical documentation

Example prompts

“Use the readme-generator skill to create or updates the GitHub README for a textbook project with badges, project overview, site metrics, and…”
“/readme-generator”

Requirements

Python 3

Workflow steps

12 steps, taken from the step headings in SKILL.md.

Analyze Repository Context
Generate Badges
Add License Badge
Create Website Link Section
Write Overview/Short Description
Add Site Status and Metrics
Add Getting Started Section
Add Issue Reporting Section
Add License Information
Add Acknowledgements
Add Contact Section
Add Optional Sections

What it can do on your machine

Read from SKILL.md and the folder at commit 98a9991. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 2 files in scripts/ (Python), which the agent can run.
Shell commands in SKILL.md call:
- python3
- pip
- python
From the folder's file list and the shell code blocks in SKILL.md.
Network
Hosts in commands or code, which the agent is likely to contact:
- img.shields.io
- github.com
- creativecommons.org
- mkdocs.org
- p5js.org
- python.org
- opensource.org
- squidfunk.github.io
- claude.ai
- username.github.io
- developer.mozilla.org
- gnu.org
- visjs.org
Also links to:
- docs.github.com
- shields.io
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Readme Generator loads about 4.9k tokens when it runs, and up to ~7.4k if it reads all its reference files. Until then it costs about 39 tokens; SKILL.md has 1,466 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~39
When it runs · the whole SKILL.md, loaded when a task matches: ~4.9k
With references · SKILL.md plus every file in references/, read only if the agent opens them: ~7.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

Its licence (CC-BY-NC-4.0) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,466 words (~4,941 tokens).

“Generate or update a comprehensive README.md file for GitHub repositories following best practices.”

— opening of SKILL.md by dmccreary, CC-BY-NC-4.0

name: readme-generator
license: Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
model: sonnet

Outline of SKILL.md

README Generator
Purpose
When to Use This Skill
Workflow
Step 1: Analyze Repository Context
Step 2: Generate Badges
Step 3: Add License Badge
Step 4: Create Website Link Section
Step 5: Write Overview/Short Description
Step 6: Add Site Status and Metrics
Step 7: Add Getting Started Section
Install Dependencies
Build and Serve Locally
Deploy to GitHub Pages
Using the Book
Step 9: Add Issue Reporting Section
Step 10: Add License Information
Step 11: Add Acknowledgements
Step 12: Add Contact Section
Step 13: Add Optional Sections
Step 14: Validate and Format
Step 15: Write README.md
Supporting Scripts
Output Files
Example Session
Quality Standards
References

Read the full SKILL.md on GitHub

Files

SKILL.md and 4 other files (scripts, references) in skills/archived/readme-generator of dmccreary/ibook-skills.

SKILL.md
README.md
references/badges.md
scripts/collect-site-metrics.py
scripts/validate-readme.py

Open the folder on GitHubat commit 98a9991

Compare with similar skills

Readme Generator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Readme Generator compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Readme Generator this skilldmccreary/ibook-skills	105	—	~4.9k	Automated safety check: Pass	CC-BY-NC-4.0	today
Update .NET OS Packagesdotnet/core	22k	—	~2.3k	Automated safety check: Pass	MIT	yesterday
Beautify GitHub Readmeoil-oil/beautify-github-readme	1.8k	—	~4.1k	Automated safety check: Pass	MIT	6 days ago
Update .NET Supported OS Matrixdotnet/core	22k	—	~4.1k	Automated safety check: Pass	MIT	yesterday
Debate ReviewamElnagdy/review-skills	132	2 repos	~1.1k	Automated safety check: Pass	MIT	yesterday
Library Documentation Seekerwithkynam/vibecode-pro-max-kit	1.1k	1 repos	~1k	Automated safety check: Notes	MIT	3 mo ago

Similar skills

Update .NET OS Packages
dotnet/core
Official
Audits and updates os-packages.json files listing the Linux packages each .NET release needs per distro, then regenerates the Markdown from the JSON.
22k GitHub stars~2.3k tokensUpdated yesterday
DevelopmentAuto-check passed
Beautify GitHub Readme
oil-oil/beautify-github-readme
Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets.
1.8k GitHub stars~4.1k tokensUpdated 6 days ago
DevelopmentAuto-check passed
Update .NET Supported OS Matrix
dotnet/core
Official
Audits and updates the supported-os.json files for .NET releases, checking them against upstream lifecycle data and regenerating the markdown with the release-notes tool.
22k GitHub stars~4.1k tokensUpdated yesterday
DevelopmentAuto-check passed
Debate Review
amElnagdy/review-skills
Two-model debate review of a GitHub PR, GitLab MR, Azure DevOps PR, or local working tree, posted as inline comments or printed.
132 GitHub starsUsed in 2 repos~1.1k tokens
DevelopmentAuto-check passed
Library Documentation Seeker
withkynam/vibecode-pro-max-kit
Looks up library and framework documentation through Context7 first, with bundled Node scripts as a fallback that fetch and analyze llms.txt files.
1.1k GitHub starsUsed in 1 repo~1k tokens
DevelopmentAuto-check: notes
Post Draft Review
agent-substrate/substrate
Posts pull request review findings as GitHub draft (pending) inline comments for a human to edit and submit, instead of publishing them straight to the PR author.
4.7k GitHub stars~2.8k tokensUpdated today
DevelopmentAuto-check passed

More from dmccreary/ibook-skills

All 32 skills in this repo

Book Publisher
dmccreary/ibook-skills
Publishes and promotes a finished intelligent textbook - GitHub README with badges and site statistics, LinkedIn announcement posts, LinkedIn carousel document posts (PPTX/PDF slideshows), and…
105 GitHub stars~1.3k tokensUpdated today
Auto-check passed
Linkedin Carousel Generator
dmccreary/ibook-skills
Generates a 13-slide LinkedIn carousel (a "document post" — PPTX/PDF) that showcases an intelligent textbook's key features, with real screenshots, mascot art, and metrics pulled from the project.
105 GitHub stars~3.7k tokensUpdated today
Auto-check passed
Add Xapi Events To Microsim
dmccreary/ibook-skills
A skill your agent uses when the user wants an existing MicroSim or chapter quiz to record what students do with it.
105 GitHub stars~5.6k tokensUpdated today
Auto-check passed
Diagram Reports Generator
dmccreary/ibook-skills
Generates a status report of all diagrams and MicroSims across an intelligent textbook's chapters, including difficulty, Bloom's level, and UI complexity.
105 GitHub starsUsed in 1 repo~1.9k tokens
Auto-check passed
DOCX To Web Publisher
dmccreary/ibook-skills
Converts .docx files (papers, briefs, reports) into styled React component pages in a Next.js content-catalog site.
105 GitHub stars~2.2k tokensUpdated today
Auto-check passed
Book Media Generator
dmccreary/ibook-skills
Generates media for intelligent textbooks - slide decks and presentations (MARP web decks in docs/slides/ or PowerPoint .pptx lecture downloads), illustrated stories and graphic novels…
105 GitHub stars~1.7k tokensUpdated today
Auto-check passed

Works with

GitHub

Questions about Readme Generator

What does Readme Generator do?

Creates or updates the GitHub README for a textbook project with badges, project overview, site metrics, and getting-started instructions. Readme Generator is an agent skill from dmccreary/ibook-skills. Creates or updates the GitHub README for a textbook project with badges, project overview, site metrics, and getting-started instructions.

When should I use Readme Generator?

Readme Generator fits situations like: tasks that involve Technical documentation.

How do I install Readme Generator in Claude Code?

Run `npx skills add dmccreary/ibook-skills --skill readme-generator -a claude-code`. Or copy the skill folder (skills/archived/readme-generator in dmccreary/ibook-skills) into .claude/skills/readme-generator in your project. Claude Code loads it when a task matches its description.

How do I install Readme Generator in Codex?

Run `npx skills add dmccreary/ibook-skills --skill readme-generator -a codex`. Or copy the skill folder (skills/archived/readme-generator in dmccreary/ibook-skills) into .agents/skills/readme-generator in your project. Codex loads it when a task matches its description.

Can I use Readme Generator in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add dmccreary/ibook-skills --skill readme-generator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-generator, .gemini/skills/readme-generator, .github/skills/readme-generator and .opencode/skills/readme-generator in your project.

What does Readme Generator need to run?

Going by SKILL.md and its folder, Readme Generator needs Python for the scripts in its folder and the command-line tools its instructions call (python3, pip and python). Our summary lists: Python 3.

Does Readme Generator access the network?

SKILL.md names 15 domains. In commands or code: img.shields.io, github.com, creativecommons.org, mkdocs.org, p5js.org, python.org, opensource.org, squidfunk.github.io, claude.ai, username.github.io, developer.mozilla.org, gnu.org and visjs.org; the agent is likely to contact these when it follows the instructions. As links in the text: docs.github.com and shields.io. This is read from the text; nothing was executed.

Is Readme Generator safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Readme Generator use?

Readme Generator is published under the CC-BY-NC-4.0 licence (declared in SKILL.md).

How many tokens does Readme Generator use?

About 4.9k tokens (SKILL.md is roughly 20k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.4k tokens, read only when the agent opens those files.

What are the alternatives to Readme Generator?

Skills that share tags, products or a category with Readme Generator: Update .NET OS Packages (dotnet/core, 22k stars), Beautify GitHub Readme (oil-oil/beautify-github-readme, 1.8k stars), Update .NET Supported OS Matrix (dotnet/core, 22k stars) and Debate Review (amElnagdy/review-skills, 132 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme Generator?

dmccreary (a GitHub user) maintains it in dmccreary/ibook-skills, which has 105 GitHub stars. The repository holds 32 skills in this directory. The repository was last updated on October 9, 2026.

Source: dmccreary/ibook-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install Readme Generator

Facts

At a glance

What it does

When your agent uses it

Example prompts

Requirements

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Files

Compare with similar skills

Similar skills

More from dmccreary/ibook-skills

Related

Questions about Readme Generator