今天给大家介绍一个Github上的README文档写作教程模版，该模版目前获得6634颗星星，2296Fork，相对而言，还是比较得到大家认可的。不花哨，不别出心裁，一个比较实用的，普适性的架子；所谓教科书式，不外如此。原文是英语，大神可直接看戳我查看。下面是我翻译的中文版（未完全按照原文翻译），献丑了。

项目名称

这里再写一句骚气又精准的话描述你的项目吧。

上手指南

写几句这样的话概括接下来的内容：以下指南将帮助你在本地机器上安装和运行该项目，进行开发和测试。关于如何将该项目部署到在线环境，请参考部署小节。

安装要求

列出运行该项目必须要具备的条件以及必须要安装的软件，最好给出具体的安装步骤。

必须安装我
我也必须安装
安装我也是必须的

安装步骤

一步一步地说明怎么去搭建环境，怎么让项目跑起来。

首先你需要

干这件事
干那件事
继续干这件事
…一直到完成。

最后阐述安装完成后的情况，展示下Demo

测试

解释说明一下如何运行该系统的自动测试部分。

分解为端对端测试

解释这些测试是什么以及为什么要做这些测试
1.我是个栗子
2.我也是个栗子
3.我是栗子的哥哥

代码风格测试

解释这些测试是什么以及为什么要做这些测试
1.我是个栗子
2.我也是个栗子
3.我是栗子的哥哥

部署

对以上的安装步骤进行补充说明，描述如何在在线环境中安装该项目。

使用到的框架

Dropwizard - Web框架
Maven - 依赖属性管理
ROME - 生成RSS源

贡献者

请阅读***CONTRIBUTING.md*** 查阅为该项目做出贡献的开发者。

版本控制

该项目使用SemVer进行版本管理。您可以在repository参看当前可用版本。

作者

地球上的盐味
您也可以在贡献者名单中参看所有参与该项目的开发者。

版权说明

该项目签署了MIT 授权许可，详情请参阅 LICENSE.md

鸣谢

该项目参考了XXX的 XXX
灵感来源于XXX
感谢女友的支持和陪伴

以上。其实在实际的写作当中，也并不一定要完全跟着这个框架来，可以根据项目情况进行增删。比如稍微复杂点的项目，就要更多的纬度去说明，那么在开头就需要列出目录（Table Of Content）。另外，图片展示也是一种常用的手段，多放图片，会让你的文档更有趣味。

关于README的写作，这里还有一份非常全面的学习资源：https://github.com/matiassingers/awesome-readme，大家也可以多多参考学习。

学习资源推荐：

第一弹：超全Python学习资源整理（入门系列）

第二弹：超全Python学习资源整理（进阶系列）

Java进阶之设计模式

Scala 开发教程

Hadoop部署及管理

RabbitMQ 消息队列

Redis基础教程

Shell脚本实现打字游戏

Python3 实现色情图片识别

Python实现3D建模工具

如何写一个优秀的GitHub项目README文档？相关推荐

如何写个优秀的Github项目Readme文档？经典模版拿去不谢~
今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得6634颗星星,2296Fork,相对而言,还是比较得到大家认可的.不花哨,不别出心裁,一个比较实用的,普适性的架子:所谓 ...
写一个可以一键统一调整word文档格式的程序
要写一个可以一键统一调整 Word 文档格式的程序,可以使用 Microsoft Office Word 的 VBA 功能来实现. 步骤如下: 打开 Word 文档,在菜单栏中点击"开发人员 ...
如何写一个好的Github项目文档
一.什么是Github? Github是通过Git进行版本控制的软件源代码托管服务平台. Github除了Git代码仓库托管及基本的Web管理界面以外,它还提供了一些方便社会化共同软件开发的功能,即一 ...
如何做一个优秀的数据分析项目？
上一篇我们普及了[数据分析项目,是什么?为什么我没做过?].今天我们系统讲解一下:如何做一个优秀的数据分析项目.首先大家要明白,并不是所有的项目,都需要找一个万人大会堂,拉着横幅,董事长总经理轮流上台 ...
学习笔记：利用markdown写readme文档（Udacity学城）
周末逛知乎等资讯平台的时候,无意间了解到Udacity学城有一期关于利用markdown撰写readme文档的教程,想到CSDN博客也提供了markdown编辑功能,而自己到现在还不会用,看着自己写的 ...
README文档模板含下载地址0积分项目文档模板 springboot文档示例 readme参考文档目录跳转项目架构使用说明目录结构等等（含附件下载）
下载地址0积分项目名称在线签约(signup) (v1.1.0) 目录项目简介功能简述项目架构目录结构使用效果安装说明使用说明开发人员版权信息更新日志项目简介 *-signu ...
【GitHub.io/Github Pages使用教程】从头开始搭建自己的Github Pages，打造个人博客网站，展示个人简历、项目、文档或想要与世界共享的任何其他内容
巨人半边莲如果你曾征服乞力马扎罗山,留意过海拔 3,657-4,267 米处的尖顶植物,这种植物有时形似绿色大柱子(或'花序'),从中间长出花序. 那么你就可能看到许多巨人半边莲,这些植物生长在非洲 ...
第十五章如何编写README文档
README 文档对于开源项目的重要性甚至会超过代码本身.你试想一下,你打开一个 Github 项目,第一时间就会看到 README 文档,而这时候同一类的项目你可能有很多选择,如果这个README不 ...
README文档的规范写法
看过很多开源库,发现有些库的文档写的一团糟,有的甚至就是一个标题,让你自己下载之后运行,自己摸索,看的很头疼.而那些使用量大的库的文档写的很标准,很详细,看的很舒服. README文档写的好的话能减少 ...

如何写一个优秀的GitHub项目README文档？