ChatGPT README Blueprint Generator for Project Setup and Testing
Turn architecture, technology, layout, and test notes into a GitHub README draft that helps a new contributor find setup and development instructions.
中文Install in ChatGPT
Use a ChatGPT workspace where skill creation is enabled. Prepare project notes from `.github/copilot/` and `.github/copilot-instructions.md`, then supply their relevant contents as source 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-blueprint-generator` 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
Supply the stack, installation steps, test command, and directory for the fictional Leaf Index project to prepare a GitHub README draft.
{"project":"Leaf Index","stack":"TypeScript","install":"make setup","tests":"make check","directory":"src/leaf-index","license":"MIT"}What to check
The setup section uses `make setup`, the stack names `TypeScript`, the project layout lists `src/leaf-index`, the testing section uses `make check`, and the license section names `MIT`.
Original SKILL.md on GitHub · Updated
Frequently asked question
Where should the ChatGPT README Blueprint Generator get its badges?
Use confirmed build, version, and license information from the project. Check all installation steps and test commands against the supplied notes before including them.