如果您的项目没有README.md，则GitHub可能会解析README.rdoc以显示详细信息。如果两者兼有，它将使用README.md，而忽略了rdoc。
简要描述您的项目。您还可以提供项目的网站链接，徽章，社区和联系信息（即电子邮件，社交网站）。
可运行文件（可执行文件或压缩文件或安装文件）链接。也可以有到以前版本的链接。
如何使用您的工作。它可能包括先决条件，设置，第三方库，用法，注意事项等。
它可能包括代码示例，gif文件，视频链接，甚至是屏幕截图。
作者姓名，联系方式等
在整个项目中得到帮助和启发的人员或社区清单
为项目做出贡献的说明（即添加功能，报告错误，提交补丁）。也可能包括文档链接。
简要介绍您的许可证。您也可以提供指向许可证站点的链接。