rishabhrawat35

GitHub Readme Writer — AI skill for Claude Code

AI community

An AI agent skill that reads every file in a repo before writing a word, then produces a README with real commands, real output and only the sections that repo needs.

How to install GitHub Readme Writer

This entry records only its repository, not the path inside it, so there is no exact command to give. Open rishabhrawat35/github-readme-writer and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

What GitHub Readme Writer does

An AI agent skill that reads every file in a repo before writing a word, then produces a README with real commands, real output and only the sections that repo needs. Includes a file inventory script and a README linter.

Alternatives in AI

Webnovel Writer — 基于 Claude Code 的长篇网文辅助创作系统，解决 AI 写作中的「遗忘」和「幻觉」问题，支持 200 万字量级连载创作 6.8k ★
Claw0 — 0 - 1 learn OpenClaw: sections to build an claw-AI agent from scratch 2.6k ★
Skill Thesis Writer — 一个专为本科/研究生论文写作设计的AI技能，支持工科、心理学、教育学、管理学等多学科领域，提供符合中国学术规范（GB/T 7714-2015）的论文写作、数据分析、参考文献管理一体化解决方案 205 ★

README

📘 GitHub README Writer

*Read every file, run every command, then write the README a stranger can use.*

**A skill for Claude (or any AI agent). It reads every file, runs every command, and writes a README with real output.**

![Skill](https://img.shields.io/badge/type-agent%20skill-informational) ![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%E2%80%933.13%20tested-blue) ![Status](https://img.shields.io/badge/status-working-green)

**Status:** working, checked 2026-09-10. No LICENSE file yet.

What is it?

Point it at a folder. You get a README a developer or PM can use with no prior context.

Two scripts do the mechanical work. `inventory.py` writes a checklist of every file. `lint.py`, the checker, fails the README on a broken link or filler word.

python3 inventory.py ~/Downloads/workflow-studio        # writes readme-inventory.md, a checklist of every file
python3 lint.py ~/Downloads/workflow-studio/README.md   # exit 1 on a broken link, bad anchor, placeholder, filler word

Agent running this skill? Read [SKILL.md](SKILL.md), the procedure. This page is for the person choosing it.

Why this and not a README template?

Nothing skipped. You get a checklist of every file: size, kind, one-line summary. The writer checks off each line; an unchecked line is a gap.
Nothing invented. Every command was run in a scratch folder. Every output is what it printed. In the run below, the imports turned up a yaml nobody had declared.
A second review that cuts. A fresh reader (CHALLENGER.md) reads the draft on a 10-second, 60-second and 10-minute clock. It demands proof for every claim and cuts any section you would not miss.
A checker that fails. `lint.py` exits 1 on broken links, dead anchors, arguments and 28 filler words (simply, powerful…). It also fails a page with no first-screen command or License heading.
Reader first. Before