oil-oil/beautify-github-readme

해결하는 문제

많은 GitHub 리포지토리에는 필요한 정보가 모두 있지만, 그 순서가 혼란스럽고, 방문자가 프로젝트의 핵심 가치를 이해하기 전에 기술적 설치 명령어나 디렉터리 트리를 먼저 보는 경우가 많습니다. 이 프로젝트는 프로젝트의 가치, 실제 사례, 사용 범위가 즉시 명확해지도록 README를 재구성하고 디자인하는 시스템을 제공합니다.

작동 방식

이 도구는 AI 에이전트 스킬로 작동하며, 리포지토리를 분석하여 가장 명확한 가치와 증거를 식별합니다. 시각적 요소와 콘텐츠 레이어를 분리하여 검색 가능성과 유지보수성을 유지합니다:

• 콘텐츠 레이어: 읽기 순서를 재정렬하고 반복을 제거하며, 내부 용어를 구체적인 결과로 대체합니다 (Markdown 형식).
• 시각 레이어: SVG를 사용해 편집 가능한 헤로, 섹션 전환, 다이어그램을 구현합니다. 결정론적 SVG 레이아웃과 AI 생성된 배경 제거 이미지를 결합한 '하이브리드' 구성도 가능하여 유기적인 질감이나 캐릭터를 표현할 수 있습니다.
• 엔지니어링 레이어: 자산이 GitHub 호환되도록 보장하고, 이미지 접근성을 확보하며, 명령어는 복사 가능하게 유지합니다.

대상 사용자

README를 긴 검색 불가능한 이미지로 바꾸지 않고도 프로젝트 홈페이지의 명확성과 시각적 정체성을 실제로 개선하고자 하는 개발자 및 오픈소스 유지보수자입니다.

주요 특징

• 두 가지 운영 모드: "전체 README" 모드(전체 재설계, 복사 및 시각 요소 포함)와 "자산 전용" 모드(헤로나 배지와 같은 특정 시각 요소 생성)를 제공합니다.
• 프로젝트 기반 디자인: 일반적인 템플릿을 피하고, 프로젝트 자체의 본질에서 색상, 타이포그래피, 모티프를 유도합니다 (예: CLI 도구는 명령어 리듬, 연구 리포지토리는 차트 사용).
• 프로젝트 충실성: 실제 프로젝트 자료만 사용하며, 능력을 창조하거나 가짜 추천을 하지 않습니다.
• 에이전트 통합: npx로 설치 가능하거나, 직접 AI 에이전트에서 요청 가능합니다.