New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Readme Generator Pro

by beizhi23 in beizhi23/README-Generator-Pro

Generate, modify, and render professional README.md files and project introduction HTML pages using the bundled README Generator Pro FastAPI application.

No licenceAuto-check: notesBackend & APIs

Install Readme Generator Pro

skills CLI
$ npx skills add beizhi23/README-Generator-Pro --skill readme-generator-pro -a claude-code

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

GitHub CLI
$ gh skill install beizhi23/README-Generator-Pro readme-generator-pro --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/beizhi23/README-Generator-Pro.git skills-src && mkdir -p .claude/skills && cp -r skills-src/readme-generator-pro .claude/skills/readme-generator-pro && 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/

Facts

Skill name
readme-generator-pro
GitHub stars
113
Token cost
~472 tokens
SKILL.md length
189 words
Files
35 (incl. scripts, assets)
Skills in repo
1
Repo updated
First seen
Licence
None found

At a glance

Generate, modify, and render professional README.md files and project introduction HTML pages using the bundled README Generator Pro FastAPI application.

  • Works in 7 steps: Locate the bundled project at this skill… → Run commands from the bundled project… → Check whether dependencies are… → …
  • The user asks Codex to generate README documentation from a GitHub repository
  • SKILL.md covers Workflow, Main Capabilities and API Notes
  • Runs Python scripts from its folder; calls pip and python

What it does

Readme Generator Pro is an agent skill from beizhi23/README-Generator-Pro. Generate, modify, and render professional README.md files and project introduction HTML pages using the bundled README Generator Pro FastAPI application. Use when the user asks Codex to generate README documentation from a GitHub repository, uploaded or local project files, modify an existing generated README, create a projectpage.html, or run the README Generator Pro web UI or REST API without changing its behavior.

Its SKILL.md is about 470 tokens, which your agent loads only when the skill is triggered. The skill folder holds 40 other files, including scripts and assets (for example `agents/openai.yaml`, `assets/readme-generator-pro/README.md` and `assets/readme-generator-pro/app/__init__.py`).

It sits in Backend & APIs, covering Technical documentation, Frontend development and HTML artifacts. It works with FastAPI and GitHub. The repository describes itself as: 基于LLM的智能README生成工具，支持GitHub链接或本地文件夹上传，自动分析项目结构并生成专业文档，提供Web UI与REST API，支持自然语言修改和项目问答.

When your agent uses it

  • The user asks Codex to generate README documentation from a GitHub repository
  • Local project files
  • Modify an existing generated README
  • Create a projectpage.html

Example prompts

  • “/readme-generator-pro”

Requirements

  • Python 3

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Locate the bundled project at this skill directory under assets/readme-generator-pro.
  2. Run commands from the bundled project directory unless the user asks for code changes.
  3. Check whether dependencies are installed. If needed, install with pip install -r requirements.txt.
  4. Use the included .env as the local configuration source. Do not print secrets from .env in chat or logs.
  5. Start the app with python run.py or scripts/start_server.ps1.
  6. Use the web UI at http://localhost:8000 or call the FastAPI endpoints directly.
  7. Preserve the existing application behavior. Do not rewrite generation logic unless the user explicitly asks to modify the project.

What it can do on your machine

Read from SKILL.md and the folder at commit 9dbe6b5. 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 1 file in scripts/ (Python, from the files we listed), which the agent can run.

    Shell commands in SKILL.md call:

    • pip
    • python

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pip, which can reach the network depending on how they are called.

    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 Pro loads about 472 tokens when it runs. Until then it costs about 111 tokens; SKILL.md has 189 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~111
When it runs · the whole SKILL.md, loaded when a task matches
~472

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: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:15
    4. Use the included `.env` as the local configuration source. Do not print secrets from `.env` in chat or logs.

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

Without a licence we can't republish the file, so here is its outline and opening line. It has 189 words (~472 tokens).

“Use the bundled FastAPI project in assets/readme-generator-pro without changing its core behavior.”

— opening of SKILL.md by beizhi23
name
readme-generator-pro

Read the full SKILL.md on GitHub

Files

SKILL.md and 34 other files (scripts, assets) in readme-generator-pro of beizhi23/README-Generator-Pro.

  • SKILL.md
  • agents/openai.yaml
  • assets/readme-generator-pro/.dockerignore
  • assets/readme-generator-pro/.env
  • assets/readme-generator-pro/.gitattributes
  • assets/readme-generator-pro/Dockerfile
  • assets/readme-generator-pro/README.md
  • assets/readme-generator-pro/app/__init__.py
  • assets/readme-generator-pro/app/api/__init__.py
  • assets/readme-generator-pro/app/api/routes.py
  • assets/readme-generator-pro/app/core/__init__.py
  • assets/readme-generator-pro/app/core/analyzer.py
  • assets/readme-generator-pro/app/core/auth.py
  • assets/readme-generator-pro/app/core/faq_generator.py
  • assets/readme-generator-pro/app/core/generator.py
  • … and 20 more

Open the folder on GitHubat commit 9dbe6b5

Compare with similar skills

Readme Generator Pro 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 Pro compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Readme Generator Pro this skillbeizhi23/README-Generator-Pro113—~472Automated safety check: NotesNone
Ros2 Web Integrationarpitg1304/robotics-agent-skills369—~13kAutomated safety check: NotesApache-2.0
Documentation Guidevolfpeter/holm132—~1.4kAutomated safety check: PassMIT
Fastcrudbenavlabs/fastcrud1.6k—~5kAutomated safety check: PassMIT
Releasezmievsa/cadwyn309—~522Automated safety check: PassMIT
Andrej Karpathy Perspectivenazarli-shabnam/clevis1702 repos~3.8kAutomated safety check: PassMIT

Similar skills

  • Ros2 Web Integration

    arpitg1304/robotics-agent-skills

    Patterns and best practices for integrating ROS2 systems with web technologies including REST APIs, WebSocket bridges, and browser-based robot interfaces.

    369 GitHub stars~13k tokensUpdated 2 mo ago
    Backend & APIsAuto-check: notes

  • Documentation Guide

    volfpeter/holm

    A skill your agent uses when writing or modifying documentation, guides, or example READMEs.

    132 GitHub stars~1.4k tokensUpdated 24 days ago
    Backend & APIsAuto-check passed

  • Fastcrud

    benavlabs/fastcrud

    A skill your agent uses when building or modifying CRUD endpoints with FastCRUD (the fastcrud PyPI package) in a FastAPI project — covers FastCRUD, crudrouter, EndpointCreator, FilterConfig…

    1.6k GitHub stars~5k tokensUpdated today
    Backend & APIsAuto-check passed

  • Release

    zmievsa/cadwyn

    Prepare and publish Cadwyn releases. An agent skill from zmievsa/cadwyn.

    309 GitHub stars~522 tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Andrej Karpathy Perspective

    nazarli-shabnam/clevis

    Andrej Karpathy的思维框架与表达方式。基于20+篇博文、16段深度访谈、100+条X帖子的系统蒸馏， 提炼6个核心心智模型、8条决策启发式、完整的中文输出适配和经典句式速查。

    170 GitHub starsUsed in 2 repos~3.8k tokens
    Backend & APIsAuto-check passed

  • Fba

    Zhongye1/KnowAgenticRAG

    FastAPI Best Architecture (fba) project development guide. An agent skill from Zhongye1/KnowAgenticRAG.

    135 GitHub stars~758 tokensUpdated yesterday
    Backend & APIsAuto-check passed

Works with

Categories

Questions about Readme Generator Pro

What does Readme Generator Pro do?

Generate, modify, and render professional README.md files and project introduction HTML pages using the bundled README Generator Pro FastAPI application. Readme Generator Pro is an agent skill from beizhi23/README-Generator-Pro.md files and project introduction HTML pages using the bundled README Generator Pro FastAPI application.

When should I use Readme Generator Pro?

Readme Generator Pro fits situations like: the user asks Codex to generate README documentation from a GitHub repository; local project files; modify an existing generated README; create a projectpage.html.

How do I install Readme Generator Pro in Claude Code?

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

How do I install Readme Generator Pro in Codex?

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

Can I use Readme Generator Pro 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 beizhi23/README-Generator-Pro --skill readme-generator-pro -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-pro, .gemini/skills/readme-generator-pro, .github/skills/readme-generator-pro and .opencode/skills/readme-generator-pro in your project.

What does Readme Generator Pro need to run?

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

Does Readme Generator Pro access the network?

SKILL.md contains no URLs. Its commands use pip, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Readme Generator Pro safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. 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 Pro use?

No licence was found for Readme Generator Pro or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does Readme Generator Pro use?

About 472 tokens (SKILL.md is roughly 1.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Readme Generator Pro?

Skills that share tags, products or a category with Readme Generator Pro: Ros2 Web Integration (arpitg1304/robotics-agent-skills, 369 stars), Documentation Guide (volfpeter/holm, 132 stars), Fastcrud (benavlabs/fastcrud, 1.6k stars) and Release (zmievsa/cadwyn, 309 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme Generator Pro?

beizhi23 (a GitHub user) maintains it in beizhi23/README-Generator-Pro, which has 113 GitHub stars. The repository was last updated on July 6, 2026.

Source: beizhi23/README-Generator-Pro on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.