readme-blueprint-generator

Name: readme-blueprint-generator
Author: github

9.3kinstalls4.6kforks

How to install readme-blueprint-generator?

github/awesome-copilot/readme-blueprint-generator

$npx -y skills add github/awesome-copilot --skill readme-blueprint-generator

Installs into the current project.

Summary

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development

Files · 1

View on GitHub

SKILL.md

1	# README Generator Prompt
2
3	Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:
4
5	1. Scan all the files in the .github/copilot folder, like:
6	- Architecture
7	- Code_Exemplars
8	- Coding_Standards
9	- Project_Folder_Structure
10	- Technology_Stack
11	- Unit_Tests
12	- Workflow_Analysis
13
14	2. Also review the copilot-instructions.md file in the .github folder
15
16	3. Create a README.md with the following sections:
17
18	## Project Name and Description
19	- Extract the project name and primary purpose from the documentation
20	- Include a concise description of what the project does
21
22	## Technology Stack
23	- List the primary technologies, languages, and frameworks used
24	- Include version information when available
25	- Source this information primarily from the Technology_Stack file
26
27	## Project Architecture
28	- Provide a high-level overview of the architecture
29	- Consider including a simple diagram if described in the documentation
30	- Source from the Architecture file
31
32	## Getting Started
33	- Include installation instructions based on the technology stack
34	- Add setup and configuration steps
35	- Include any prerequisites
36
37	## Project Structure
38	- Brief overview of the folder organization
39	- Source from Project_Folder_Structure file
40
41	## Key Features
42	- List main functionality and features of the project
43	- Extract from various documentation files
44
45	## Development Workflow
46	- Summarize the development process
47	- Include information about branching strategy if available
48	- Source from Workflow_Analysis file
49
50	## Coding Standards
51	- Summarize key coding standards and conventions
52	- Source from the Coding_Standards file
53
54	## Testing
55	- Explain testing approach and tools
56	- Source from Unit_Tests file
57
58	## Contributing
59	- Guidelines for contributing to the project
60	- Reference any code exemplars for guidance
61	- Source from Code_Exemplars and copilot-instructions
62
63	## License
64	- Include license information if available
65
66	Format the README with proper Markdown, including:
67	- Clear headings and subheadings
68	- Code blocks where appropriate
69	- Lists for better readability
70	- Links to other documentation files
71	- Badges for build status, version, etc. if information is available
72
73	Keep the README concise yet informative, focusing on what new developers or users would need to know about the project.

People who liked this also viewed

6 picks

Type

readme-blueprint-generator

9.3kinstalls4.6kforks

View on GitHub

How to install readme-blueprint-generator?

github/awesome-copilot/readme-blueprint-generator

$npx -y skills add github/awesome-copilot --skill readme-blueprint-generator

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# README Generator Prompt
2
3	Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:
4
5	1. Scan all the files in the .github/copilot folder, like:
6	- Architecture
7	- Code_Exemplars
8	- Coding_Standards
9	- Project_Folder_Structure
10	- Technology_Stack
11	- Unit_Tests
12	- Workflow_Analysis
13
14	2. Also review the copilot-instructions.md file in the .github folder
15
16	3. Create a README.md with the following sections:
17
18	## Project Name and Description
19	- Extract the project name and primary purpose from the documentation
20	- Include a concise description of what the project does
21
22	## Technology Stack
23	- List the primary technologies, languages, and frameworks used
24	- Include version information when available
25	- Source this information primarily from the Technology_Stack file
26
27	## Project Architecture
28	- Provide a high-level overview of the architecture
29	- Consider including a simple diagram if described in the documentation
30	- Source from the Architecture file
31
32	## Getting Started
33	- Include installation instructions based on the technology stack
34	- Add setup and configuration steps
35	- Include any prerequisites
36
37	## Project Structure
38	- Brief overview of the folder organization
39	- Source from Project_Folder_Structure file
40
41	## Key Features
42	- List main functionality and features of the project
43	- Extract from various documentation files
44
45	## Development Workflow
46	- Summarize the development process
47	- Include information about branching strategy if available
48	- Source from Workflow_Analysis file
49
50	## Coding Standards
51	- Summarize key coding standards and conventions
52	- Source from the Coding_Standards file
53
54	## Testing
55	- Explain testing approach and tools
56	- Source from Unit_Tests file
57
58	## Contributing
59	- Guidelines for contributing to the project
60	- Reference any code exemplars for guidance
61	- Source from Code_Exemplars and copilot-instructions
62
63	## License
64	- Include license information if available
65
66	Format the README with proper Markdown, including:
67	- Clear headings and subheadings
68	- Code blocks where appropriate
69	- Lists for better readability
70	- Links to other documentation files
71	- Badges for build status, version, etc. if information is available
72
73	Keep the README concise yet informative, focusing on what new developers or users would need to know about the project.

People who liked this also viewed

6 picks

Type