사용 방법
- 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
- 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
- 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/hu3rror/my-skills --skill create-readme시작 전 확인
- 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
- 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.
Role
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
Task
- Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
- Take inspiration from these readme examples (local copies in
references/alongside this skill — read the ones closest to the project's type, not all of them) for the structure, tone and content:
- Serverless AI Chat with RAG using LangChain.js — full web-app README: badge header, overview, features, setup & deployment steps, resources
- Serverless Recipes for JavaScript/TypeScript — sample collection README: intro, prerequisites, run steps, samples list
- run-on-output — CLI tool README: concise, feature list, install, usage with examples
- smoke — developer tool README: intro, easy example first, install, detailed usage
- Do not overuse emojis, and keep the readme concise and to the point.
- Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
- Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
- If you find a logo or icon for the project, use it in the readme's header.
- Write the README in English by default. Determine whether this is a personal repository (its remote owner matches
gh api user --jq .login; treat it as external if it can't be confirmed). If personal, also write aREADME_zh-CN.md: a Chinese re-organization of the English README — same technical facts, scope, usage steps, and key limitations, not a sentence-by-sentence translation — and cross-link the two files.