Add prompt for creating a comprehensive README.md file#82
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a new prompt for generating a README.md file and updates the main index to include it
- Introduce
prompts/create-readme.prompt.mdwith instructions for crafting a comprehensive README - Update
README.mdto list the new Create Readme prompt alongside existing templates
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| prompts/create-readme.prompt.md | New prompt file defining a README generation workflow |
| README.md | Added entry for the Create Readme prompt in the index |
Comments suppressed due to low confidence (1)
README.md:82
- [nitpick] The prompt title 'Create Readme' is inconsistent with the conventional 'README'; consider using 'Create README' for clarity and consistency.
| [Create Readme](prompts/create-readme.prompt.md) | Create a README.md file for the project | [](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-readme.prompt.md) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-readme.prompt.md) |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
aaronpowell
approved these changes
Jul 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
node update-readme.jsand verified thatREADME.mdis up to date.Description
Creates a README.md file for the project, using some references. The resulting readme is well-suited for open source projects.
Type of Contribution
Additional Notes
See result of this prompt here: https://github.com/sinedied/run-on-output/tree/main (there were few manual tweaks after)
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.