一键在 Manus 中运行任何 Skill

opensource-readme-generator

星标17

分支5

更新时间2025年12月23日 11:23

Generate high-quality, "All-Star" README files for open-source repositories. Use this skill when a user asks to create, update, or improve a README.md file for their project.

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

在 Manus 中运行

来源

irahardianto

irahardianto/qurio

打开 GitHub 仓库查看创作者相关仓库

下载

在 Manus 中运行

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 -R or 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.
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.
- Use this template as the structure for your output.
- Do not just copy the template blindly. Fill in the placeholders (github_username, repo_name, etc.) with real data from the project or reasonable placeholders if unknown.
- Customize the badges in the "Built With" section to match the technologies actually used in the project.
Consult Guidelines:
- Refer to references/readme-guidelines.md to ensure you are meeting the "All-Star" criteria (clarity, visuals, completeness).

Workflow

Understand: Read the user's request and explore the codebase to understand what the project does.
Draft: Create a draft of the README.md in your mind or a scratchpad, mapping project details to the template sections.
Refine: Check against references/readme-guidelines.md.
Output: Write the content to README.md (or a file specified by the user) using the write_file tool.

Tips

Badges: Always include badges. They make the repo look active and professional.
Visuals: If you can't generate a screenshot, add a placeholder like ![Screenshot](path/to/screenshot.png) and tell the user to replace it.
Tone: Keep the tone professional, welcoming, and helpful.

同仓库更多 Skills

同仓库

debugging-protocol

irahardianto/qurio

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.

2025-12-2617

frontend-design

irahardianto/qurio

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.

2025-12-2117

knowledge-searching

irahardianto/qurio

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'.

2025-12-2117

technical-constitution

irahardianto/qurio

Generates technical implementation plans and architectural strategies that enforce the Project Constitution. Use when designing new features, starting implementation tasks, refactoring code, or ensuring compliance with critical standards like Testability-First Architecture, security mandates, testing strategies, and error handling.

2025-12-2117

name	opensource-readme-generator
description	Generate high-quality, "All-Star" README files for open-source repositories. Use this skill when a user asks to create, update, or improve a README.md file for their project.
license	MIT

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 -R or 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.
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.
- Use this template as the structure for your output.
- Do not just copy the template blindly. Fill in the placeholders (github_username, repo_name, etc.) with real data from the project or reasonable placeholders if unknown.
- Customize the badges in the "Built With" section to match the technologies actually used in the project.
Consult Guidelines:
- Refer to references/readme-guidelines.md to ensure you are meeting the "All-Star" criteria (clarity, visuals, completeness).

Workflow

Understand: Read the user's request and explore the codebase to understand what the project does.
Draft: Create a draft of the README.md in your mind or a scratchpad, mapping project details to the template sections.
Refine: Check against references/readme-guidelines.md.
Output: Write the content to README.md (or a file specified by the user) using the write_file tool.

Tips

Badges: Always include badges. They make the repo look active and professional.
Visuals: If you can't generate a screenshot, add a placeholder like ![Screenshot](path/to/screenshot.png) and tell the user to replace it.
Tone: Keep the tone professional, welcoming, and helpful.