ChatGPT readme-builder skill for a concise project README
Write a scannable README using actual features, dependencies, usage, and limitations with a minimal example for technical readers.
中文Install in ChatGPT
A ChatGPT workspace with skill creation enabled. The example uses only the supplied plain-text material.
- In a ChatGPT workspace with skill creation enabled, open Plugins → Skills → Create → Create with editor.
- Create a skill in the editor and adapt the text-only `readme-builder` workflow from the pinned GitHub source into its instructions.
- Save the skill, then type @ in a new chat to select it and try the example.
Example task
Manually select readme-builder and turn these fictional project facts into a README that opens with the purpose.
project `Leaf Desk` | purpose=compare two plant labels on a desk
usage `Compare Labels` | sample `Fern and Aloe` | limitation `prototype only`
no coverage data or badges requestedWhat to check
Show `Compare Labels` with `Fern and Aloe` as the minimum example. Mark `prototype only` and omit badges and unsupported coverage claims.
Original SKILL.md on GitHub · Updated
Frequently asked question
Should I add a test coverage number to make the README look complete?
Use verified project facts and a minimal example so readers understand the scope quickly.