如何写好Github中的readme？

好的readme，如何才算好，一定要有高逼格，好吧，中文不够国际化，一定要有英文版本

首先logo很重要放在最上面，如

，然后起一个最耍帅的名字，如

：Walden 最适合东半球同学使用的文档框架。

最重要的，一定要有一个官方主页介绍，不求漂亮、高大上，至少做得大方得体，瓦尔登官方主页：

。最好为它申请一个专业的域名，如瓦力官方主页：http://walle-web.io，.io域名比.com贵太多了：( 不过，好马配好鞍，谁让它是我的理想寄托，值！

介绍当然是少不了，这块可高大上，可幽默，看个人文笔了，目前我还没想好一套超酷的，先等着。

对于技术的readme，一定要各种icon：travis、scrutinizer、packagist这些标配

至于什么安装，快速开始，功能列表这不啰嗦了，然后就是尽量给个截图或者gif，吸引兴趣，让用户看到完成之后的样子。带个todo list，告诉用户我们还要继续做，很有盼头！

然后就是要带流程图、原理图，画漂亮点，这些都是得分点，让用户更清楚了解，减少解答。当然，最好自带FAQ！！！

自带change log，让用户知道每个版本都有哪些更新，修正了哪些bug。

最后就是问题交流，放上issue地址和qq群，促进交流，及时发现问题。最近

保持高速更新发版，就是跟用户互动发现需求和问题的，欢迎试用标星，fork: )

谢邀，不过我没有写过readme的经历。如果现在要我写的话，我只能先参考下那些已经写好的。有段时间我研究过sublime text的插件，不少插件源码是放在github上的，readme写得很清晰漂亮，至少把设置和使用方法都写清楚了。看到不少代码中的readme是.md格式的，看来markdown很流行。还有一个readme给我留下深刻印象的是lighttpd。

guodongxiaren/README

敬请关注

我们在 Github 上创建新项目的时候，常常会看到默认使用 README 文件初始化该项目，然后在新建项目的根目录下就会生成一个 README.md 文件。

那究竟什么是 README ？它有什么特殊的功能？我们要如何操作才能写出一个漂亮的 README 呢？

一个合格的老司机想要在 Github 上了解一个项目，首先都会去翻看该项目的 README 文件，因为这个小小的静态文件其实传达了整个项目的概述，如项目的介绍、代码实现的功能、系统环境参数、部署要素等。

README 文件后缀名为 md，当然扩展名也可能是 txt ，rb 等。md 是 markdown 的缩写，是一种轻量级的「标记语言」。它用「标记」语法，来代替常见的字处理软件中大量的排版格式，从而让大家能够更专注于文字内容，是适合所有人的写作语言。

大家可以通过以下链接来进一步学习 markdown 的写作：

Markdown 语法说明

Markdown 在线工具

如果 README 包括下面的内容，那么当使用者打开项目，浏览 README 后，基本就知道该如何下手了。

• 项目简介
• 功能特性
• 环境依赖
• 部署步骤
• 目录结构描述
• 版本内容更新
• 声明
• 协议

当然这不是一个绝对的模板，但是其中有些必要的元素（如项目的介绍，使用，部署及目录结构）还是需要列出来。

关注码云微信公众号：mayunOSC

发现更多优质开源项目：最新推荐 - 码云 - 开源中国

让团队流畅、高效开发：码云企业版 - 码云 - 开源中国

GitHub 项目堪称教科书的 README，那一定要推荐 Standard Readme。

看名字你应该就知道这是什么了，就是标准 README 应该写哪些内容，应该怎样排版等等。

先放上链接：

这个 README 标准是由 RichardLitt 发起，十多名开发者共同贡献完成的，在 GitHub 上有 1230+ Star。

你的 README 文件通常是你开源项目的第一个入口点。你应该通过 README 明确地告诉大家，为什么他们应该使用你的项目，他们如何安装它，以及他们如何使用它。

因此我相信很多人急需一份标准化的 README 编写方式，帮助你更轻松地创建和维护 REAMDME。所以 Standard Readme 这个项目就诞生了。

一个标准的 README 应该包含哪些内容呢：

• 项目背景
• 安装
• 使用
• Badge
• 相关项目（可选）
• 主要项目负责人
• 参与贡献方式
• 开源协议

项目背景很简单，就是你为什么做这个项目，动机和背景是什么。

安装和使用也很简单，清晰明了即可，例如：

Badge 是一个很好玩的东西，当然是可选的，非必须。如下图：

相关项目就是还有哪些与你做的类似的项目，如果你感兴趣可以列出来，例如：

项目主要负责人可以通过很多方式展现出来，直接艾特标注是最简单的方式：

参与贡献方式就是写清楚大家可以怎样参与这个项目的贡献，可简单，可繁琐，例如：

License 就是你这个项目的开源协议，具体可以阅读协议介绍去选择一款适合你的：

以上就是一个 GitHub 项目的 README 应该具备的内容，这个回答对你有帮助的话就点个赞吧～