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 - Rich Markdown功能,现代布局,清晰描述,符合推荐的社区标准.
  • athityakumar/colorls - 多个徽章. 清理截图. 简单的安装说明. TOC便于导航. 良好的贡献者指南.
  • ccostan/Home-AssistantConfig - 项目横幅. 徽章. 轻松导航.
  • choojs/choo - 徽章,干净,清晰. 美丽的小菜单折叠与有用的链接. 其中的常见问题解答主要问题. 支持者. 好语言.
  • Day8/re-frame - 徽章,徽标,TOC等.通过撰写一篇关于技术,如何使用它,它背后的哲学以及它如何适应更大生态系统的巨型,写得很好的文章而脱颖而出.
  • iterative/dvc - ReStructuredText格式示例,兼容PyPi. 徽标,定制网站式菜单. 流畅的动画效果. 徽章. 很棒的贡献部分与名人堂.
  • github-changelog-generator/github-changelog-generator - TOC便于导航. 简洁的项目描述. 安装和使用部分. 输出示例. 伟大的功能概述. 替代品清单. 常问问题.
  • gitpoint/git-point - 清晰的描述. 项目标志. App Store徽标. TOC. 清理截图. 功能列表. 详细的安装过程. 登陆页面.
  • Hexworks/Zircon - 自述中的Dogfood. 清楚地描述项目的作用. 演示截图. TOC便于导航. 带有屏幕截图的简易安装和设置部分. 进一步阅读的链接.
  • iharsh234/WebApp - 项目登陆页面. 清楚地描述项目的作用. 演示截图. 简单的安装和使用部分. 包括具有常见用途的示例部分和移动演示部分.
  • jakubroztocil/httpie - 描述项目的作用. 演示截图. 项目标志. TOC便于导航. 建立徽章. 快速简单的安装和使用部分. 包括示例部分.
  • karan/joe - 项目标志. 清楚地描述项目的作用. GIF演示. 易于安装和使用部分.
  • Martinsos/edlib - 信息徽章(构建,版本,出版物). 简洁描述. 功能列表. TOC. 截图. 简明的说明以及在项目中构建和包含的示例. 常见的代码示例,可帮助您快速入门.
  • nhn/tui.editor - 项目标志. 使用演示GIF清楚地了解项目功能. 徽章. TOC便于导航. 在标题前面的五颜六色的象.
  • node-chat - 项目截图. 信息徽章. 清楚的描述. 易于安装/使用说明. 现场演示.
  • NSRare/NSGIF - 项目标志. GIF演示. 用法艺术品. 使用代码示例.
  • sidneycadot/oeis - 概述. 所需依赖项列表. 回购中所有文件的完整列表及其功能. 它是如何联系在一起的视觉图形.
  • php-censor/php-censor - 多个徽章,项目徽标,屏幕截图,分步安装和升级说明,TOC以便于导航.
  • Rebilly/redoc - 多个徽章,项目徽标,现场演示链接,关键功能的GIF动画,TL; DR使用.
  • React on lambda - 项目徽标,漫画,以呈现主要想法,徽章,带有代码片段的示例,演示项目,api文档,编辑器配置.
  • rstacruz/hicat - GIF演示. 带有屏幕截图的简易安装和设置部分. 建立徽章. 用例的很好的例子.
  • ryanoasis/nerd-fonts - 清洁项目徽标. 顶部简要说明. Sankey图,快速链接,徽章,操作系统特定图标,TOC,详细发布更改日志.
  • 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清楚地了解项目功能. 徽章. 可扩展的TOC. 用法说明和示例. 贡献指南. 详细发布.
  • 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

在README中嵌入动画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 - 如果您点击“预订审核”,则免费提供README标准化和反馈.
  • 这个存储库. 用自述文件提交PR!

Contribute

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

License

CC0

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