Readme

Awesome README Awesome

>精选自述文件清单

漂亮的自述文件中的元素包括但不限于:图像,屏幕截图,GIF,文本格式等.

Examples

  • ai/size-limit -项目徽标,清晰的说明,屏幕截图,分步安装说明.
  • aimeos/aimeos-typo3 -项目徽标. 明确说明项目的用途. 演示截图. TOC便于导航. 带有屏幕截图的简单安装和设置部分. 链接以供进一步阅读.
  • alichtman/stronghold -项目徽标. 明确说明项目的用途. GIF演示. TOC便于导航. 徽章. 链接以供进一步阅读. 简单的安装说明.
  • amitmerchant1990/electron-markdownify -项目徽标. 关于它的极简描述. 该项目的GIF演示. 主要特征. 如何安装指南. 学分.
  • anfederico/Clairvoyant -多个徽章. 干净的徽标. 简单的安装说明. 清晰的项目概述以及原理图. GIF演示. 大量的代码示例.
  • ngcolombia/medellin -项目横幅. 统计数据的徽章. 放置位置好的表情符号. 贡献者的照片.
  • Armync/Arminc-AutoExec -丰富的Markdown功能,现代布局,清晰的说明并符合建议的社区标准.
  • athityakumar/colorls -多个徽章. 清理屏幕截图. 简单的安装说明. TOC便于导航. 良好的贡献者准则.
  • ccostan/Home-AssistantConfig -项目横幅. 徽章. 轻松导航.
  • choojs/choo -徽章,干净清晰. 折页上方漂亮的小菜单,包含有用的链接. 里面的常见问题解答. 支持者. 好语言
  • Day8/re-frame -徽章,徽标,TOC等.它是一篇关于技术,如何使用它,其背后的哲学以及如何适应更大的生态系统的宏伟且写得很好的文章.
  • iterative/dvc -ReStructuredText格式示例,与PyPi兼容. 徽标,类似自定义网站的菜单. 流畅的动画制作方式. 徽章. 名人堂不错的贡献部分.
  • github-changelog-generator/github-changelog-generator -目录便于导航. 简洁的项目描述. 安装和使用部分. 输出示例. 很棒的功能概述. 替代品列表. 常问问题.
  • gitpoint/git-point -清晰的说明. 项目徽标. App Store徽标. 目录. 清理屏幕截图. 功能列表. 详细的安装过程. 登陆页面.
  • Hexworks/Zircon -自述文件中的Dogfood. 明确说明项目的用途. 演示截图. TOC便于导航. 带有屏幕截图的简单安装和设置部分. 链接以供进一步阅读.
  • iharsh234/WebApp -项目登陆页面. 明确说明项目的用途. 演示截图. 简单的安装和使用部分. 包括一个具有常用功能的示例部分和一个移动演示部分.
  • jakubroztocil/httpie -项目功能说明. 演示截图. 项目徽标. TOC便于导航. 制作徽章. 快速和简单的安装和使用部分. 包括示例部分.
  • karan/joe -项目徽标. 明确说明项目的用途. GIF演示. 易于安装和使用的部分.
  • Martinsos/edlib -信息徽章(内部版本,版本,出版物). 简洁的描述. 功能列表. 目录. 屏幕截图. 简洁的说明以及用于构建和包含在项目中的示例. 通用代码示例可帮助您快速入门.
  • nhn/tui.editor -项目徽标. 使用演示GIF清晰地概述了项目功能. 徽章. TOC便于导航. 在标题前面的彩色图标.
  • node-chat -项目截图. 信息徽章. 清晰的说明. 简单的安装/使用说明. 现场演示.
  • NSRare/NSGIF -项目徽标. GIF演示. 用法图稿. 使用代码示例.
  • sidneycadot/oeis -概述. 所需依赖项列表. 回购中所有文件的完整列表及其功能. 有关如何将它们联系在一起的直观图表.
  • php-censor/php-censor -多个徽章,项目徽标,屏幕截图,分步安装和升级说明以及便于导航的目录.
  • Rebilly/redoc -多个徽章,项目徽标,实时演示链接,关键功能的GIF动画,TL; DR使用情况.
  • React on lambda -项目徽标,代表主要思想的漫画,徽章,带有代码片段的示例,演示项目,api文档,编辑器配置.
  • React Parallax Tilt -GIF演示. 多个徽章. 功能列表. 精彩的现场演示和代码示例. 易于按照说明进行本地开发.
  • rstacruz/hicat -GIF演示. 带有屏幕截图的简单安装和设置部分. 制作徽章. 用例的好例子.
  • ryanoasis/nerd-fonts -清洁项目徽标. 顶部简要说明. Sankey图,快速链接,徽章,特定于操作系统的图标,目录,详细的发行变更日志.
  • sebyddd/SDVersion -项目徽标. 制作徽章. 多种编程语言的文档结构. 用法示例.
  • shama/gaze -项目徽标. 简洁的描述. 功能列表. 使用部分. 常问问题. 很棒的API文档. 发布历史.
  • sindresorhus/pageres -项目徽标. 明确说明项目的用途. 制作徽章. 演示截图. 简单的安装和使用部分. 包括一个具有常用用法的示例部分.
  • sourcerer-io/sourcerer-app -清理动画截图. 定制的号召性用语徽章. 用法展示.
  • sr6033/lterm -使用字符清洁徽标. 开发的简要更新. 详细的贡献准则. 贡献建议.
  • supunlakmal/thismypc -项目徽标. 有用的徽章. 网址. 屏幕截图. GIF安装的分步说明. 项目文件夹结构.
  • teles/array-mixer -清洁项目徽标,徽章. 目录. 贡献部分. 许多图解的例子.
  • thelounge/thelounge -项目徽标. 有用的徽章和链接(网站,文档,演示). 屏幕截图. 功能列表. 有关安装,开发和测试的分步说明. 链接到贡献指南. 好的手机摘要.
  • vhesener/Closures -项目徽标,认知漏斗,动画示例. 颜色协调. 清理文档.
  • release-it/release-it -使用演示GIF清晰地概述了项目功能. 徽章. 可扩展目录. 用法说明和示例. 贡献准则. 详细发布.
  • dowjones/react-dropdown-tree-select - Clear readme with GIF screenshot for quick demo. Multiple badges, concise ToC, online playground, storybook, detailed description and more.

Articles

Tools

  • Common Readme -Node的通用自述文件样式. 包括指南和自述文件生成器.
  • Feedmereadmes -自述文件编辑和项目分析/反馈.
  • Hall-of-fame -帮助在README上显示对回购贡献者的认可. 拥有新的/趋势/杰出贡献者. 每小时更新一次.
  • Make a README -编写自述文件的指南. 包括带有实时Markdown渲染的可编辑模板.
  • README best practices -从以下位置复制粘贴README.md的地方
  • readme-md-generator -生成漂亮的README.md文件的CLI
  • Standard Readme -标准的README样式规范. 也有一个生成器来帮助创建符合规范的自述文件.
  • Zalando's README Template -简单的模板,可帮助您涵盖所有基础知识.

Creating GIFs

在自述文件中嵌入动画gif可以快速演示您的项目做什么,并引起读者的注意. 以下是一些程序,可以帮助您快速为项目创建gif:

  • Gifox - $ 4.99 -最干净的用户界面,热键和许多高级功能
  • Giphy Capture -免费-易于上传到giphy.com,用户体验有些烦人.
  • LICEcap -免费-不太直观,更多功能
  • Recordit -免费-简单,干净的用户界面,但会自动上传到 recordit.co
  • Peek -免费-简单易用的Linux用户.
  • ScreenToGif -免费-开源,可自定义的用户界面和易于编辑的GIF,易于上手.
  • ttystudio -免费-对于命令行工具,使用终端到gif记录器可以减轻麻烦.
  • Gifski -免费-比其他颜色更鲜艳,但尺寸仍然较小

Get Feedback

  • feedmereadmes -免费的README编辑和反馈,使您的开源项目不断发展. 请参阅README成熟度模型,以帮助您继续前进.
  • maintainer.io -如果您单击“预订审核”,则免费提供自述文件标准化和反馈. -这个储存库. 使用您的自述文件提交PR!

Contribute

永远欢迎捐款! 请阅读 contribution guidelines 第一.

License

CC0

在法律允许的范围内, Matias Singers 已放弃此作品的所有版权以及相关或邻近的权利.