git上README.md文件编写基本方法，方便git界面直接看到漂亮的说明

一.搭建实时看README.md效果的环境：

window10平台

1.安装Node.js

官网下载安装

 

win+r    cmd下 查看安装是否安装成功

node -v
npm -v 查看版本

2.安装Docsify CLI‌

全局安装Docsify命令行工具：

bashCopy Code

 npm install docsify-cli -g

3‌.创建项目目录‌
新建文件夹（如my-docs），进入目录后执行：

bashCopy Code

docsify init ./docs

‌4.启动本地服务

bashCopy Code

docsify serve ./docs

访问http://localhost:3000查看效果‌

 

二.基础README.md 内容示例

# 产品名：
> （中文&英文 如：低应变分析软件 & YL-PIT）
# 开发环境：
> （QT程序要备注Qt、QC版本，编译器、调试器信息，VM上开发产品要说明虚拟机主机名。QtOnAndroid的产品，注明SDK、NDK、JDK版本）
# 版本号：
>（完整版本号，特殊版本包含后缀）
# 备注：
>（特殊清空备注说明，如定制版、专版等）

效果如下：