github readMe

231 阅读1分钟
  • 项目背景
  • 安装
  • 使用
  • Badge
  • 相关项目
  • 主要项目负责人
  • 参与贡献方式
  • 开源协议

小点:


格式:

项目名开篇,用最大标题,其他都是下一级标题

超链接:

超链接:[文本](地址)

如:

[超链接实验](https://github.com/RichardLitt/standard-readme#badge)

image.png

徽章 Badge


1、格式有svn 和 png 之分:

用svn(矢量图形), 因为png放大会失真

[![图片文字说明](图片源地址)](超链接地址)

[![Author](https://img.shields.io/badge/Author-Jifengzhiyu-yellow.svg "Author:Jifengzhiyu")](https://github.com/jifengzhiyu/MyFirst_IOS_StudyMaterial "Author")

image.png 解析:

1)Author 标签分类(自定义)

2)img.shields.io/badge/ 固定

3)Author-Jifengzhiyu-yellow 标签分类名-标签名-颜色

4)"Author:Jifengzhiyu" 鼠标停留显示的文字

5)github.com/jifengzhiyu… 点击跳转的地址

6)"Author" 标签分类(自定义)

7)没有说的固定

2、有关超链接:

没有超链接的格式:

![Author](https://img.shields.io/badge/Author-Jifengzhiyu-yellow.svg "Author:Jifengzhiyu")

没有超链接点开就是一张网页图片

3、颜色:

image.png

相关项目


image.png

项目主要负责人


image.png

参与贡献


image.png

协议


image.png


参考:

github.com/RichardLitt…