kierangao/general-readme-skill
Developer tools이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요. 원문 보기
的 AI 目生成美美化的 README 文件 AI Assistants Skill을 사용하여 모든 프로젝트에 대한 전문 & Beautified README 파일 생성.
개요
AI 코딩 조수 Zero Dependencies · Multi-Platform · Multi-Language · Support Claude Code, Copilot, Cursor 등을 사용하여 모든 프로젝트를 위한 일반 README 기술 생성하기 전에 구성 옵션을 수집합니다. 모든 옵션은 고정 기본 값이 있습니다. - (기본: 영어) - (선택: 중국어, 일본어, 한국어, 스페인어, 프랑스어, 러시아어, 등) 내장된 도구를 사용하여 로컬 프로젝트 디렉토리를 스캔합니다. package.json을 가진 전형적인 Node.js 프로젝트: 로드 참조 파일, 다음 (Inverted Pyramid)에 따라 콘텐츠를 생성합니다. 참조 / 폴더에 위치한 모든 참조 : bash npm 설치 my-package bash cp .env.example .env bash npm 실행 dev `
개요(AI 번역)
일반 README 기술
AI 코딩 조수를 가진 증거 기반 README 파일 생성 및 업데이트
v2.0.0 · 설정 확인 · Git-Aware 업데이트 · 멀티 플랫폼 · 다국어
한국어 · English · 中文 · Русский
빠른 시작
이 저장소 (directory general-readme-skill)는 두 가지 기술을 제공합니다. readme-write README 파일을 생성하고 [T2]] 는 Git 변경에서 현재 유지됩니다. 핵심 워크플로우는 Native Agent read/search/edit 도구를 사용합니다. 옵션 오프라인 체크인자는 ** Python 3.9 + ** 및 제 3 자 패키지가 없습니다.
readme-write 설치
복사 SKILL.md, references/] 및 scripts/]] readme-write]라는 기술 디렉토리에. 상대적인 경로가 그대로 유지하십시오. SKILL.md]만 설치하면 워크플로가 불완전합니다.
다른 대상 프로젝트의 경우, 프로젝트의 절대 기술 디렉토리를 목적지로 사용하고 기존 팀 지시를 덮지 않는다. 통합 가이드 보기: Claude Code, GitHub Copilot, Cursor. 파일 배치를 설명합니다. 호스트 로딩은 설치된 호스트에서 확인되어야 합니다.
이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요.
README
원문 README의 일부입니다. 원문 보기.
General README Skill
Create and update evidence-based README files with AI coding assistants
v2.0.0 · Preference Confirmation · Git-Aware Updates · Multi-Platform · Multi-Language
English · 中文 · 日本語 · 한국어 · Русский
Quick Start
This repository (directory general-readme-skill) provides two skills: readme-write creates README files and readme-update keeps them current from Git changes. The core workflow uses native agent read/search/edit tools. The optional offline checkers need Python 3.9+ and no third-party packages.
Install readme-write
Copy SKILL.md, references/ and scripts/ together into a skill directory named readme-write. Keep their relative paths intact; installing only SKILL.md leaves the workflow incomplete.
mkdir -p .claude/skills/readme-write
cp SKILL.md .claude/skills/readme-write/
cp -r references/ scripts/ .claude/skills/readme-write/
For another target project, use that project’s absolute skill directory as the destination and do not overwrite existing team instructions. See the integration guides: Claude Code, GitHub Copilot, Cursor. They describe file placement; host loading must be verified in the installed host. Natural-language invocation is the portable option; /readme-write and /readme are trigger phrases, not guaranteed slash commands.
Get the first result
Ask the host agent:
Write a README for this project
The first response bundles the unresolved preferences and stops until you answer. Reply with your choices or “use the recommended settings”. After acceptance, the agent inspects static project evidence, writes the agreed README files, and reports what was checked.
To delegate choices explicitly:
추천 도구
다른 키워드를 입력하거나 필터를 제거해 보세요.
설치
npx skillfish add kierangao/general-readme-skill