oil-oil/beautify-github-readme

해결하는 문제

많은 GitHub 저장소는 필요한 모든 정보를 갖추고 있지만, 제시 순서가 좋지 않아 방문자가 프로젝트의 가치를 이해하기 전에 설치 명령과 같은 기술적 세부 사항을 먼저 보게 되는 경우가 많습니다. 이 프로젝트는 프로젝트의 가치, 실제 증명, 사용 경로가 즉시 명확해지도록 README를 재설계하는 시스템을 제공합니다.

작동 방식

이 도구는 AI 에이전트 스킬로 작동하여 저장소를 분석하고 핵심 가치와 증명을 식별합니다. 검색 가능성과 유지 관리성을 유지하기 위해 시각적 레이어와 콘텐츠 레이어를 분리합니다.

• 콘텐츠 레이어 (Content Layer): 읽기 순서를 개선하고, 중복을 제거하며, 내부 전문 용어를 구체적인 결과물로 대체합니다.
• 시각적 레이어 (Visual Layer): 편집 가능한 히어로 이미지, 섹션 전환 및 다이어그램에 SVG를 사용합니다. 결정론적 SVG 레이아웃과 AI로 생성된 배경 제거 이미지를 결합하여 유기적인 질감이나 캐릭터가 포함된 하이브리드 구성을 만들 수 있습니다.
• 엔지니어링 레이어 (Engineering Layer): 에셋이 GitHub에서 안전하게 사용될 수 있고, 이미지가 접근 가능하며, 명령어가 복사 가능하도록 보장합니다.

대상 사용자

README를 검색할 수 없는 긴 이미지로 바꾸지 않으면서 프로젝트의 가치 제안을 명확하고 전문적으로 만들고 싶은 개발자 및 오픈 소스 관리자.

주요 특징

• 두 가지 작동 모드: 텍스트와 비주얼을 완전히 재설계하는 'Whole README' 모드와 히어로 이미지나 배지와 같은 특정 시각적 요소를 만드는 'Asset-only' 모드를 제공합니다.
• 하이브리드 비주얼: SVG의 정밀함과 AI로 생성된 래스터 소재를 결합하여 영화 같은 조명과 복잡한 질감을 구현합니다.
• 계층 우선 접근 방식: 내부 용어나 설치 단계보다 프로젝트의 가치와 증명을 우선시합니다.
• 프로젝트 네이티브 디자인: 일반적인 템플릿을 사용하는 대신 프로젝트 자체에서 타이포그래피, 색상, 구성을 도출합니다.