Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Generating a repository README v1.0.0

Use this resource to write a repository README from its existing documentation

New

  • 421 downloads
  • 188 likes
  • 165 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install repository-readme-generation

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent goes through the .github/copilot folder and the copilot-instructions.md file, extracts the name, stack, architecture and conventions, then writes a structured README. You get a document ready for review.

Mostly picked by

Updated November 2, 2026

Card for the “Generating a repository README” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: steps for analyzing the documentation files
  • SKILL.md: README sections (getting started, structure, testing, contributing, license)

Good fit for

  • Your repository has no README although internal documentation exists
  • You want a README aligned with conventions already written down

Not for

    Tags

    • readme
    • documentation
    • repository
    • markdown

    About

    You say

    “Generate the README for this repository from the .github/copilot folder.”

    Card for the “Generating a repository README” skill

    Skill published by github under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to write a repository README from its existing documentation
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md2.8 KB

    Origin and licence

    Listed unmodified

    Author
    github
    Source
    github.com/github/awesome-copilot/tree/0fe6545b950671641b2b14b44eb56678fea6c6b4/skills/readme-blueprint-generator
    Licence
    MIT

    Notice

    « readme-blueprint-generator » (github, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.