github 自述文件
示例
如果您的项目没有README.md,则GitHub可能会解析README.rdoc以显示详细信息。如果两者兼有,它将使用README.md,而忽略了rdoc。
自述文件可能包括-
项目名称
简要描述您的项目。您还可以提供项目的网站链接,徽章,社区和联系信息(即电子邮件,社交网站)。
下载
可运行文件(可执行文件或压缩文件或安装文件)链接。也可以有到以前版本的链接。
安装
如何使用您的工作。它可能包括先决条件,设置,第三方库,用法,注意事项等。
示范
它可能包括代码示例,gif文件,视频链接,甚至是屏幕截图。
s
作者姓名,联系方式等
致谢
在整个项目中得到帮助和启发的人员或社区清单
贡献
为项目做出贡献的说明(即添加功能,报告错误,提交补丁)。也可能包括文档链接。
执照
简要介绍您的许可证。您也可以提供指向许可证站点的链接。
热门推荐
1 狗狗技能训练
5 如何训练狗狗笑
6 狗狗训练排便
9 狗狗响片训练
10 如何训练狗狗不捡食
11 狗狗尿训练
12 怎么训练狗狗找东西
13 狗狗训练站立
14 狗狗训练飞盘
15 鞍山狗狗训练
16 怎样训练泰迪狗狗谢谢
17 狗狗外出训练
18 怎么训练金毛狗狗大小便