自述文件

如果你的项目没有 README.md,GitHub 可能会解析 README.rdoc 以显示详细信息。如果它有两者,它将使用 README.md,默默地忽略 rdoc。

自述文件可包括─

项目名称

简要描述一下你的项目。你还可以提供项目的网站链接,徽章,社区和联系信息(即电子邮件,社交网站)。

下载

可运行文件(可执行文件或缩小文件或安装文件)链接。也可以链接到以前的版本。

安装

如何使用你的工作。它可能包括先决条件,设置,第三方库,用法,注意事项等。

示范

它可能包括代码示例,gif 文件,视频链接,甚至屏幕截图。

作者

作者姓名,联系信息等

致谢

在整个项目中帮助和激发了人员或社区的名单

特约

向项目提供贡献(即添加功能,报告错误,提交补丁)的说明。也可能包含文档链接。

执照

简要介绍一下你的许可证。你也可以提供许可证站点的链接。