taewoongkim2/awesome-readme

큐레이션된 멋진 Repository README 리스트

Awesome README

A curated list of awesome READMEs

Elements in beautiful READMEs include, but are not limited to: images, screenshots, GIFs, text formatting, etc.

Examples

• MananTank/radioactive-state - 배지(버전, 다운로드, 적용 범위, 크기), Twitter 의도, 프로젝트 로고, 기능 목록, 동기 부여, 설치, GIF, 이모티콘, 접을 수 있는 섹션, 라이브 데모, API 세부 사용법, FAQ, 채팅 링크의 예.
• Martinsos/edlib - 유익한 배지(빌드, 버전, 출판). 간결한 설명. 기능 목록. 목차. 스크린샷. 프로젝트에 구축하고 포함하기 위한 예제와 함께 간결한 지침. 빠르게 시작할 수 있는 일반적인 코드 예제.
• nhn/tui.editor - 프로젝트 로고. 데모 GIF로 프로젝트 기능에 대한 명확한 개요. 배지. 쉬운 탐색을 위한 목차. 제목 앞의 다채로운 아이콘입니다.
• ai/size-limit - 프로젝트 로고, 명확한 설명, 스크린샷, 단계별 설치 지침.
• aimeos/aimeos-typo3 - 프로젝트 로고. 프로젝트가 하는 일에 대한 명확한 설명. 데모 스크린샷. 쉬운 탐색을 위한 목차. 스크린샷이 있는 쉬운 설치 및 설정 섹션. 더 읽을 수 있는 링크..
• ajeetdsouza/zoxide - 배지, 프로젝트 GIF, 간결한 설명, 빠른 링크, 단계별 설치 지침.
• alichtman/shallow-backup - 프로젝트가 하는 일에 대한 명확한 설명. GIF 데모. 쉬운 탐색을 위한 목차. 배지. 더 읽을 수 있는 링크. 간단한 설치 지침.
• alichtman/stronghold - 프로젝트가 하는 일에 대한 명확한 설명. GIF 데모. 쉬운 탐색을 위한 목차. 배지. 더 읽을 수 있는 링크. 간단한 설치 지침.
• amitmerchant1990/electron-markdownify - 프로젝트 로고. 프로젝트가 하는 일에 대한 명확한 설명. GIF 데모. 쉬운 탐색을 위한 목차. 배지. 더 읽을 수 있는 링크. 간단한 설치 지침.
• anfederico/Clairvoyant -여러 배지. 깔끔한 로고. 간단한 설치 지침. 회로도와 함께 프로젝트에 대한 명확한 개요. GIF 데모. 광범위한 코드 예제.
• aregtech/areg-sdk -설명 그래픽과 함께 프로젝트 및 사용 사례에 대한 설명입니다. 여러 도구 및 통합 지침을 사용하여 빌드하고 지침을 참조하여 첫 번째 프로젝트를 만듭니다. 예. 프로젝트 로고. 여러 배지. 그래픽이 있는 헤드라인. 쉬운 탐색을 위한 목차.
• Armync/Arminc-AutoExec - 풍부한 마크다운 기능, 현대적인 레이아웃, 명확한 설명 및 권장 커뮤니티 표준 준수.
• athityakumar/colorls - 여러 배지. 깨끗한 스크린샷. 간단한 설치 지침. 쉬운 탐색을 위한 목차. 좋은 기여자 지침.
• ccostan/Home-AssistantConfig - 프로젝트 배너. 배지. 쉬운 탐색.
• choojs/choo - 배지, 깨끗하고 투명합니다. 유용한 링크가 있는 스크롤 없이 볼 수 있는 아름다운 작은 메뉴. 주요 질문에 대한 FAQ입니다. 후원자. 좋은 언어.
• chroline/well_app - 깔끔한 배지와 다운로드 정보 및 빠른 탐색 링크가 있는 눈길을 끄는 프로젝트 썸네일을 제공합니다. 여러 설명 섹션으로 구성되어 있으며 각 섹션에는 노란색 이모티콘이 있는 제목이 있습니다. 프로젝트 자체, 사용된 기술 및 기여 방법에 대한 세부 정보가 포함됩니다.
• create-go-app/cli - 프로젝트 로고를 정리합니다. 유용한 배지(버전, 코드 스타일, 테스트 커버, 문서). 빠른 시작이 포함된 명확한 추가 정보, 이해하기 쉬운 설치 및 사용 설명서, 비디오 스크린캐스트, 잘 문서화된 프로젝트 기능이 포함된 목차(터미널에서 작업의 데모 녹음 포함), 프로젝트 철학 노트("다른 이유"), 가장 자주 묻는 질문, 그리고 더..
• Day8/re-frame - 배지, 로고, 목차 등. 기술, 사용 방법, 그 이면의 철학 및 더 큰 생태계에 어떻게 들어맞는지에 대해 잘 쓰여진 거대 에세이로 눈에 띕니다.
• dowjones/react-dropdown-tree-select - 빠른 데모를 위해 GIF 스크린샷으로 readme 지우기. 여러 배지, 간결한 ToC, 온라인 플레이그라운드, 스토리북, 자세한 설명 등.
• easybase/easybase-react - 프로젝트 배너 및 로고. 배지. 확장 가능한 연습 섹션. 간결한 설명과 목적. 쉬운 탐색을 위한 목차. 설치 데모용 GIF. 여러 유익한 시각 자료.
• github-changelog-generator/github-changelog-generator - 쉬운 탐색을 위한 목차. 간결한 프로젝트 설명. 설치 및 사용 섹션. 출력 예. 훌륭한 기능 개요. 대안 목록. 자주하는 질문.
• • gitpoint/git-point - 명확한 설명. 프로젝트 로고. 앱 스토어 로고. 목차. 깨끗한 스크린샷. 기능 목록입니다. 자세한 설치 과정. 방문 페이지.
• gofiber/fiber - 깨끗한 프로젝트 로고. 유용한 배지 및 링크(언어 전환기, 코드 스타일, 테스트 표지, 문서, Discord 채널). 빠른 시작으로 프로젝트가 수행하는 작업에 대한 명확한 설명, 벤치마크 차트, 잘 문서화된 코드 예제(긴 콘텐츠를 숨길 수 있는 기능 포함), 프로젝트 철학 노트("프로젝트의 이유"), 프로젝트 애드온이 있는 표, 기여자 목록, 별표 성장 통계 등.
• Hexworks/Zircon - Readme의 Dogfood. 프로젝트가 하는 일에 대한 명확한 설명. 데모 스크린샷. 쉬운 탐색을 위한 목차. 스크린샷이 있는 쉬운 설치 및 설정 섹션. 더 읽을 수 있는 링크.
• iharsh234/WebApp - 프로젝트 랜딩 페이지. 프로젝트가 하는 일에 대한 명확한 설명. 데모 스크린샷. 간단한 설치 및 사용 섹션. 일반적으로 사용되는 예제 섹션과 모바일 데모 섹션이 포함되어 있습니다.
• iterative/dvc - ReStructuredText 형식의 예, PyPi 호환. 로고, 사용자 정의 웹 사이트와 같은 메뉴. 부드러운 작동 방식 애니메이션. 배지. 명예의 전당이 있는 멋진 기여 섹션.
• jakubroztocil/httpie - 프로젝트가 하는 일에 대한 설명. 데모 스크린샷. 프로젝트 로고. 쉬운 탐색을 위한 목차. 배지를 만드세요. 빠르고 간단한 설치 및 사용 섹션. 예제 섹션이 포함되어 있습니다.
• karan/joe - 프로젝트 로고. 프로젝트가 하는 일에 대한 명확한 설명. GIF 데모. 쉬운 설치 및 사용 섹션.
• L0garithmic/FastColabCopy - 프로젝트 로고. 미니멀리스트 설명. 배지. GIF 데모. 프로젝트 소개. 사용하는 방법. 예. 크레딧. 추가 예.
• ma-shamshiri/Human-Activity-Recognition - 아름다운 목차. 프로젝트 로고. 애니메이션 프로젝트 배너입니다. 프로젝트 폴더 구조를 완료하십시오. 프로젝트가 하는 일에 대한 명확한 설명. 멋진 기여자 섹션. 쉬운 탐색.
• ma-shamshiri/Pacman-Game - 아름다운 목차. 프로젝트 로고. 애니메이션 프로젝트 배너입니다. 프로젝트의 각 부분을 표시하는 데 적합한 GIF. 기능과 함께 리포지토리에 있는 프로젝트 파일의 전체 목록입니다. 실행 명령을 완료하십시오.
• ma-shamshiri/Spam-Detector - 전체 프로젝트 파일 설명. 프로젝트 로고. 애니메이션 프로젝트 배너입니다. 간결한 프로젝트 설명. 실행 명령을 지웁니다.
• ngcolombia/medellin - 프로젝트 배너입니다. 통계 배지. 잘 배치된 이모티콘. 기여자의 사진.
• node-chat - 프로젝트 스크린샷. 유익한 배지. 명확한 설명. 쉬운 설치/사용 지침. 라이브 데모.
• NSRare/NSGIF - 프로젝트 로고. GIF 데모. 사용법 삽화. 사용 코드 샘플.
• OliverOverend/gym-simplifiedtetris - GIF 데모. 프로젝트에 대한 간략한 설명입니다. 배지. 목차. 복사 붙여넣기 가능한 주석 및 종속성이 있는 설치 및 사용 지침. 기여 파일. 제공된 환경 및 에이전트 개요.
• php-censor/php-censor - 다중 배지, 프로젝트 로고, 스크린샷, 단계별 설치 및 업그레이드 지침, TOC 쉬운 탐색.
• PostHog/posthog - 맞춤형 섹션 아이콘, 데모 GIF, 배포 버튼, 기여자를 위한 프로필 이미지, 간결하고 명확한 구조, 프로젝트 로고.
• priyavrat-misra/xrays-and-gradcam - 쉬운 탐색을 위한 목차. 프로젝트가 하는 일에 대한 명확한 소개. t에 있는 모든 파일의 전체 목록

Articles

• "Art of Readme - Learn the art of writing quality READMEs." - Stephen Whitmore
• "How To Write A Great README" - Caleb Thompson (thoughtbot)
• "Readme Driven Development" - Tom Preston-Werner
• "Top ten reasons why I won’t use your open source project" - Adam Stacoviak
• "What I learned from an old GitHub project that won 3,000 Stars in a Week" - KyuWoo Choi

Tools

• Amazing GitHub Template - 유용한 README.md, LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, GitHub 문제, 풀 요청 및 작업 템플릿을 사용하여 프로젝트를 빠르게 시작할 수 있습니다.
• Common Readme - Node.js의 일반적인 추가 정보 스타일입니다. 안내서와 추가 정보 생성기가 포함되어 있습니다.
• Feedmereadmes - README 편집 및 프로젝트 분석/피드백.
• Hall-of-fame - README에서 repo 기여자에게 인정을 표시하는 데 도움이 됩니다. 신규/트렌드/최고 기여자를 제공합니다. 매시간 업데이트됩니다.
• Make a README - README 작성 가이드. 라이브 Markdown 렌더링이 포함된 편집 가능한 템플릿이 포함되어 있습니다.
• README best practices - README.md를 복사하여 붙여넣을 수 있는 위치
• readme-md-generator - 아름다운 README.md 파일을 생성하는 CLI
• Readme.so - 프로젝트의 readme에 필요한 모든 섹션을 빠르게 추가하고 사용자 지정할 수 있는 간단한 편집기입니다.
• READMINE - 소프트웨어 프로젝트를 위한 철저하고 명확하며 자체 설명적인 README 파일 템플릿. 복사하고 필요에 따라 편집하십시오.
• StackEdit - 프로젝트 추가 정보에 필요한 모든 섹션을 빠르게 사용자 지정할 수 있는 사용자 친화적인 온라인 편집기입니다.
• Standard Readme - 표준 README 스타일 사양입니다. 사양 준수 README를 생성하는 데 도움이 되는 생성기도 있습니다.
• Zalando's README Template - 모든 기본 사항을 다루는 데 도움이 되는 간단한 템플릿입니다.

Creating GIFs

Embedding an animated gif in your README quickly demonstrates what your project does and catches the reader's eye. Here are a few programs that can help you quickly create gifs for your project:

• Gifox - $14.99 - Cleanest UI, hotkeys, lots of advanced features
• Gifski - FREE - More vivid colors than the rest, but still keep size low
• Giphy Capture - FREE - Easy to upload to giphy.com, slightly annoying UX.
• LICEcap - FREE - Less intuitive, more features
• Peek - FREE - Simple and easy to use for Linux users.
• Recordit - FREE - Simple, clean UI, but auto-uploads to recordit.co
• ScreenToGif - FREE - Open source, customizable UI and easily editable GIFs, easy to get started.
• terminalizer - FREE - Record your terminal and generate animated gif images or share a web player
• ttystudio - FREE - For commandline tools, a terminal-to-gif recorder minus the headaches.

Get Feedback

• feedmereadmes - Free README editing+feedback to make your open-source projects grow. See the README maturity model to help you keep going.
• maintainer.io - Free README standardization and feedback, if you click on 'Book an audit'.
• This repository. Submit a PR with your README!

Contribute

Contributions are always welcome! Please read the contribution guidelines first.

License

To the extent possible under law, Matias Singers has waived all copyright and related or neighboring rights to this work.