README Generator Pro skill
A skill that runs a local service writing a README and a project page with diagrams from a GitHub link or a project folder.
- 112 ★ on the repository
- Last commit
Extended access
Why this level
- Project code is sent to the chosen LLM provider.
- The API key is stored in a `.env` file next to the skill.
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add skills/readme-generator-proDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- Project code is sent to the chosen LLM provider.
- The API key is stored in a `.env` file next to the skill.
This is third-party code. Review the repository files before installing.
What it does
README Generator Pro is a FastAPI app that analyses repository structure, dependencies and entry points, then writes `README.md` through an LLM. It also builds a `project_page.html` project page with Mermaid diagrams. The skill in the `readme-generator-pro` directory tells the agent how to start the app with `python run.py` and call the REST endpoints `/api/generate`, `/api/modify` and `/api/generate_html_page`. A finished README can be edited with plain-language requests.
Who it is for. Developers and open-source authors who want a first README draft without assembling the structure by hand.
Good fit when
- A new repository has no docs and needs a README draft.
- A project demo needs a page with an architecture diagram.
- An agent must rewrite the installation section of an existing README on request.
- Docs are generated from an uploaded project archive.
Not a fit when
- Source code cannot be sent to an external LLM provider.
- You need FAQ generation from Issues, which the author lists as still in development.
- The repository is too small to produce a meaningful README.
Example request
Generate a README for the repository at this link, then shorten the installation section and add a project page.Limitations
An OpenAI-compatible API key is required and is read from `.env`. Project content goes to the chosen LLM provider. If `.env` stays inside the skill directory, do not publish that directory. The repository states no licence, and the last commit is dated July 2026. The free Render demo instance sleeps when idle. README quality depends on the chosen model and project size, so proofread the result.
How to disable. Remove the `readme-generator-pro` skill directory from the agent's skills folder, stop the `python run.py` process and delete the `.env` file holding the key.
FAQ
Which sources does the app accept?
A GitHub repository link, an uploaded project folder and a ZIP archive. The project language is detected automatically.
How do I start the interface?
Run `python run.py` in the app directory and open `http://localhost:8000`. The same operations are available over REST.
Does it work in Claude Code?
Yes, copy the skill directory into `~/.claude/skills`. The author documents setup for Codex and for Claude Code separately.
Is a separate key needed?
Yes, an OpenAI-compatible API key such as OpenAI or DeepSeek. It goes into `.env` and the agent must not print secrets into chat.
Can a finished README be edited?
Yes. The `/api/modify` endpoint accepts plain-language changes, for example about section order or brevity.
Discussion
No questions or reviews yet.
Related
SkillsReadmeAI analyzes repository files and drafts a README with a project overview, directory structure and setup guidance.
A skill and local renderer: an agent draws three SVG diagrams of a project from its README and sources, no keys or network needed
explainmyrepo turns a GitHub repository into an explainer page and a knowledge pack an agent answers from.
A skill and CLI that turn Markdown into DOCX, PDF, PPTX, XLSX, PNG and about a dozen more formats, all computed locally
A skill that draws 45 types of animated diagrams from a short JSON spec and saves them as HTML, SVG, PNG, GIF and MP4
Learn from materials
learn-from-materials
A skill that turns books, PDFs, slides and documents into a traceable knowledge base and an interactive learning page with sources, maps and self-check
Comparison with similar tools
Cards that share the main search query, and how they differ.
| Tool | Official | Repository stars | Main difference |
|---|---|---|---|
| README Generator Pro (this card) | no | 112 | |
| Readme.skill | no | 175 | edits and formats a README; README Generator Pro analyses the code and writes the document from scratch, plus a page with diagrams |
| beautify-github-readme | no | 1,960 | beautifies an existing README; here an LLM creates the docs from the project structure |
README in short
The app analyses a project and builds a README and a description page with Mermaid diagrams. The skill wrapper only tells the agent how to start the app and call its API.