[TOC] #### 1. 介绍 --- README.md：项目的自述文件，用于介绍项目整体的一个概览 README.md 一般出现在 git 仓库的根目录下，作用是对项目的主要信息进行描述 如果一个项目很长时间没有修改了，突然你需要修改这个项目，通过查看 README.md 对项目的描述可以让你快速上手，当别人接手你的项目或你接手别人的项目也能快速的了解该项目 #### 2. 规范 --- 对于刚接手项目的陌生人，应该通过 README.md 快速获取到项目内容的要点，因此其内容应该是项目整体的一个概览。其实这个文件内容有约定俗成的规范，这个规范也是众多开源开发者相互磨合形成的。文件内容理应围绕下面内容编写： 1. 项目介绍 2. 运行环境要求 3. 依赖的第三方插件 4. 部署要素，操作说明 5. 代码结构说明（目录结构） 6. 开发环境，测试环境，正式环境域名等参数说明 README.md 内容结构公认比较漂亮的一种是 `logo + 徽章 + 正文`，Vue 仓库就是如此：<https://github.com/vuejs/vue>  很多非开源项目并不会专门设计自述文件的 logo，将 logo 换为项目名称也是挺好看的，如下所示：  自述文件中对于标题的选用： + 项目名称使用一级标题 + 项目介绍使用二级标题，项目介绍下面的内容使用三级标题，依次类推 #### 3. 徽章 --- 人活一张脸，树活一张皮，git 仓库也不例外，好看的仓库从 README 开始，而好看的 README 从置顶的小徽章开始 置顶徽章生成网站：<https://shields.io/#your-badge> 输入想要的标签文字和颜色，就可以得到一个最简单的个性徽章 使用查询字符串参数 style 可以自定义徽章样式： + flat 扁平化，默认效果 + flat-square 扁平化+去圆角 + for-the-badge 扁平化+去圆角+放大 + social 社交样式 + plastic 立体效果 ``` https://img.shields.io/badge/Node-12.18.2-yellowgreen?style=plastic ``` #### 4. 模板 --- 居中的项目 logo： Markdown 支持内嵌 HTML 代码，将下面代码直接放于 README.md 中即可 ```html <p align="center"> <a href="https://vuejs.org" target="_blank"> <img width="100" src="https://vuejs.org/images/logo.png"> </a> </p> ``` 居中的项目名称： ```html <h1 align="center">康盈养老PC管理后台</h1> ``` 项目名称下面一般都是放置漂亮的徽章： ```html <p align="center"> <img src="https://img.shields.io/badge/PHP-7.3-green" /> <img src="https://img.shields.io/badge/MySQL-5.7-green" /> <img src="https://img.shields.io/badge/Node.js-12.18.2-green" /> </p> ``` 自述文件的正文： ``` ## 运行环境 --- | 环境 | 接口域名 | 后台域名 | | --- | --- | --- | | 本地环境 | http://192.168.1.183 | xxx | | 测试环境 | http://test.itqaq.com | xxx | | 正式环境 | http://www.itqaq.com | xxx | ``` #### 5. 示例 --- ```markdown <p align="center"> <a href="https://vuejs.org" target="_blank"> <img width="100" src="https://vuejs.org/images/logo.png"> </a> </p> <h1 align="center">康盈养老PC管理后台</h1> <p align="center" style="margin-bottom:16px;"> <img src="https://img.shields.io/badge/PHP-7.3-green" /> <img src="https://img.shields.io/badge/MySQL-5.7-red" /> <img src="https://img.shields.io/badge/Node.js-12.18.2-green" /> </p> <p align="center"> Vue3 组件库，Typescirpt 编写，高性能，支持按需引入、国际化、可配置主题。 </p> ## 项目介绍 --- ## 依赖插件 --- | 插件名称 | 插件官网 | | --- | --- | | z-paging | https://z-paging.zxlee.cn | | uview-ui | https://www.uviewui.com | ## 项目部署 --- ## 环境说明 --- | 环境 | 接口域名 | 后台域名 | | --- | --- | --- | | 测试环境 | `https://test.itqaq.com` | https://api.itqaq.com | | 正式环境 | `https://blog.itqaq.com` | https://api.itqaq.com | ```