opensource-readme-generator
Open Source README Generator
This skill helps you generate professional, comprehensive, and visually appealing README files for open-source projects.
Usage Guidelines
When a user asks to create or improve a README:
-
Analyze the Project:
- Look at the files in the current directory (using
ls -Ror similar tools if allowed/safe) to understand the project type (Node.js, Python, Go, etc.). - Identify key components:
package.json,requirements.txt, source code folders, tests. - Determine the project name and purpose.
- Look at the files in the current directory (using
-
Gather Information:
- If the project purpose isn't clear from the code, ask the user for a brief description, "elevator pitch", or key features.
- Ask about specific sections if they are missing (e.g., "Do you have a demo link?", "What is the license?").
-
Use the Template:
- Read the template at
assets/all-star-readme-template.md.
- Read the template at
More from irahardianto/monarch
mobile-design
Create distinctive, production-grade mobile interfaces with high design quality using Flutter. Use this skill when the user asks to build mobile apps, screens, widgets, animations, or UI components. Generates creative, polished Flutter code that avoids generic standard widget aesthetics.
12knowledge-searching
Retrieves implementation knowledge, code examples, and documentation references. Use to inform technical decision-making when the user requires specific library usage, framework patterns, or syntax details. Trigger on requests to 'search docs', 'find code examples', or 'check implementation details'.
10debugging-protocol
Comprehensive protocol for validating root causes of software issues. Use when you need to systematically debug a complex bug, flaky test, or unknown system behavior by forming hypotheses and validating them with specific tasks.
8frontend-design
Generates distinctive, production-grade frontend interfaces and artifacts (React, Vue, HTML/CSS). Prioritizes bold aesthetics, unique typography, and motion to avoid generic designs. Use when building websites, landing pages, dashboards, posters, or when the user requests to style, beautify, or create visually striking UI.
8sequential-thinking
Performs dynamic, reflective problem-solving through iterative thought chains. Use for complex planning requiring revision, branching, backtracking, or hypothesis verification. Ideal for multi-step analysis where context maintenance is required or the full scope isn't initially clear.
8brand-identity-creator
Comprehensive guide for creating brand identity guidelines. Use this skill when a user wants to define, create, or document a brand's identity, including mission, vision, values, personality, and visual elements.
8