github 自述文件
示例
如果您的项目没有README.md,则GitHub可能会解析README.rdoc以显示详细信息。如果两者兼有,它将使用README.md,而忽略了rdoc。
自述文件可能包括-
项目名称
简要描述您的项目。您还可以提供项目的网站链接,徽章,社区和联系信息(即电子邮件,社交网站)。
下载
可运行文件(可执行文件或压缩文件或安装文件)链接。也可以有到以前版本的链接。
安装
如何使用您的工作。它可能包括先决条件,设置,第三方库,用法,注意事项等。
示范
它可能包括代码示例,gif文件,视频链接,甚至是屏幕截图。
s
作者姓名,联系方式等
致谢
在整个项目中得到帮助和启发的人员或社区清单
贡献
为项目做出贡献的说明(即添加功能,报告错误,提交补丁)。也可能包括文档链接。
执照
简要介绍您的许可证。您也可以提供指向许可证站点的链接。
热门推荐
6 保研的祝福语简短
10 年轻20岁祝福语简短
11 朋友结婚祝福语信息简短
12 女孩婚礼贺卡祝福语简短
13 30段点歌简短祝福语
14 虎年春节祝福语图文简短
15 写给后妈祝福语大全简短
16 简短回复生日祝福语
17 校长送毕业祝福语简短
18 毕业立体贺卡祝福语简短