首页 > 其他分享 >README.md文档编写

README.md文档编写

时间:2023-06-21 14:14:12浏览次数:38  
标签:md Markdown service js 语法 json 文档 README

为什么要写README文件?

因为README的编写,过了很长时间后,你仍然知道你当初写了什么;因为README的编写,其他人看你的代码不需要那么费劲;因为README的编写,你代码的质量就大大的提高;因为README的编写,你的语言水平就大大的提高了,所以说README应该简短,大家不要以为写这个很麻烦,这个东西能够节省你和别人的很多时间。

完整的README包括什么内容?

1,软件定位,软件的基本功能
 
2,运行代码的方法:安装环境,启动命令等
 
3,简要的使用说明
 
4,代码目录结构说明,更详细点可以说明软件的基本原理
 
5,常见问题说明

它包括了一下内容:

1,项目和所有子模块和库的名称(对于新用户,有时不同命名会导致混乱)
 
2,对所有项目,和所有子模块和库的描述
 
3,如何使用 5-line code(如果是一个库)
 
4,版权和许可信息(或阅读许可证)
 
5,抓取文档指令
 
6,安装、配置和运行程序的指导
 
7,抓取最新代码和构建它们的说明(或快速概述和「阅读 Install」)
 
8,作者列表或「Read AUTHORS」
 
9,提交bug,功能要求,提交补丁,加入邮件列表,得到通知,或加入用户或开发开发区群的介绍
 
10,其他联系信息(电子邮件地址,网站,公司名称,地址等)
 
11,一个简短的历史记录(更改,替换或者其他)
 
12,法律声明

一个简单的范本

我们前期写的话,不必要那么麻烦,就写几个简单的必要的东西,比如法律声明啊,联系记录啊等等,就不必要写


DEMO
===========================

###########环境依赖
node v0.10.28+
redIs ~

###########部署步骤
1. 添加系统环境变量
    export $PORTAL_VERSION="production" // production, test, dev


2. npm install  //安装node运行环境

3. gulp build   //前端编译

4. 启动两个配置(已forever为例)
    eg: forever start app-service.js
        forever start logger-service.js


###########目录结构描述
├── Readme.md                   // help
├── app                         // 应用
├── config                      // 配置
│   ├── default.json
│   ├── dev.json                // 开发环境
│   ├── experiment.json         // 实验
│   ├── index.js                // 配置控制
│   ├── local.json              // 本地
│   ├── production.json         // 生产环境
│   └── test.json               // 测试环境
├── data
├── doc                         // 文档
├── environment
├── gulpfile.js
├── locales
├── logger-service.js           // 启动日志配置
├── node_modules
├── package.json
├── app-service.js              // 启动应用配置
├── static                      // web静态资源加载
│   └── initjson
│       └── config.js         // 提供给前端的配置
├── test
├── test-service.js
└── tools



###########V1.0.0 版本内容更新
1. 新功能     aaaaaaaaa
2. 新功能     bbbbbbbbb
3. 新功能     ccccccccc
4. 新功能     ddddddddd

MarkDown 使用

1,代码高亮

2,制作代办事项To-do List

3,高效绘制流程图,序列图,甘特图,表格

3-1流程图

3-2 序列图

3-3 甘特图

3-4,表格

4,书写数学公式

MarkDown的常用语法

1,标题

标题是每篇文章必备而且最常用的格式。
在Markdown中,如果想将一段文字定义为标题,只需要在这段文字前面加上 #,再在 # 后加一个空格即可。还可增加二、三、四、五、六级标题,总共六级,只需要增加 # ,增加一个 # ,标题字号相应降低一级。如图:

2,列表

列表格式也很常用,它可以让你的文稿变得井井有条。在 Markdown 中,你只需要在文字前面加上 - 就可以了;如果你希望是有序列表,在文字前面加上 1. 2. 3. 即可。

注:-、1.和文字之间要保留一个字符的空格。

3,引用

如果你需要在文稿中引用一段别处的句子,那么就要用到「引用」格式。
在引用文字前加上 > 并与文字保留一个字符的空格,即可。

4,粗体和斜体

Markdown 的粗体和斜体也非常简单:
用两个 * 包含一段文本就是粗体的语法;
用一个 * 包含一段文本就是斜体的语法。

5,链接与图片

链接:在 Markdown 中,插入链接只需要使用 显示文本 即可。
图片:在 Markdown 中,插入图片只需要使用 显示文本即可。

注:插入图片的语法和链接的语法很像,只是前面多了一个 !

6,分割线

分割线的语法只需要另起一行,连续输入三个星号 *** 即可分割两段文字内容。
如图:

7,表格

当你需要在Markdown文稿中键入表格,代码如下:


原文章地址:

https://www.cnblogs.com/huliangqing/p/16191141.html

标签:md,Markdown,service,js,语法,json,文档,README
From: https://www.cnblogs.com/1399z3blog/p/17494101.html

相关文章

  • 小技巧 ---- 白嫖deep文档翻译
    问题虽然deep提供免费的文档翻译,但是有字数和大小的翻译限制。超过必须收费。问题是暂时不支持中国订阅。思路只要消减到符合要求即可步骤假设我有一个pdf超过了字数限制,那么我们可以分割pdf1.用百毒pdf分割后转word,https://box.baidu.com/ndtool/home#/。分割,将文件用二分法测试分......
  • 通用能力及AI核心能力表现优异!合合信息智能文档处理系统(IDP)高评级通过中国信通院评估
    数字经济快速发展的背后,全球数据总量呈现出爆发式增长趋势。智能文档处理(IDP)技术能够高效地从多格式文档中捕捉、提取和处理数据,帮助机构和企业大幅提升文档处理效率,节约时间和人力成本。近期,合合信息智能文字识别产品通过中国信息通信研究院(以下简称“中国信通院”)“可信AI—智能......
  • 台达PLC Modbus通讯程序文档内容: Modbus RTU简介 台达MS300变频器写频率
    台达PLCModbus通讯程序文档内容:ModbusRTU简介台达MS300变频器写频率,读电流、报警;施耐德ATV12变频器的写频率,读状态、输出频率;金田JTE320S变频器的写频率,读电流、报警;易驱CV310变频器的写频率,读状态、输出电流、频率、报警;台达CP2000变频器的写启停、频率,读输出频率、电流、状态......
  • 直接电流双闭环控制方式的pwm整流器仿真,带建模计算技术文档simulink仿真,电流内环采用
    直接电流双闭环控制方式的pwm整流器仿真,带建模计算技术文档simulink仿真,电流内环采用滞环控制电压外环为pi控制授人之鱼,不如授人之渔带pwm整流的传递函数推导,PID参数,硬件参数计算文档。所带资料还包含一个传递函数的仿真。ID:5349595753777152......
  • ABS模型汽车simulinkABS模型,参数都有,而且有说明文档
    ABS模型汽车simulinkABS模型,参数都有,而且有说明文档ID:386595909448289......
  • Prometheus文档--1概述
    概述什么是Prometheus?Prometheus是一个开源监控系统和报警工具,Prometheus将其指标收集并存储为时间序列数据,即指标信息与记录的时间戳以及称为标签的可选键值对一起存储。特征:Prometheus的主要特点是:具有指标名称和键/值对标识的时间序列数据的多维数据模型PromQL,一种......
  • 数据指纹的生成,hashlib.md5的使用
    content=li.xpath('./div[1]/text()').extract_first()title=li.xpath('./div[2]/a/text()').extract_first()all_data=title+content#生成该数据的数据指纹importhashlib#导入一个生成数据指纹的模块m......
  • 2、【java数据安全】base64与报文摘要MD(md5、sha、mac)简单介绍及应用场景、示例
    (文章目录)本文简单的介绍了Base64、消息摘要和其使用示例,并且使用示例以三种不同实现方式及测试本文介绍三种实现方式,即JDK、apachecommons.codec和bouncycastle三种。一、maven依赖<dependency> <groupId>org.testng</groupId> <artifactId>testng</artifactId> <......
  • MD204L文本modbus rtu控制监控变频器资料效果可以看视频,有两种文本都试过可以的,两条通
    MD204L文本modbusrtu控制监控变频器资料效果可以看视频,有两种文本都试过可以的,两条通讯线就能控制正反转,停止及频率设定,以及对运行参数的监控,方便又节约成本,内容包括软件,文本的说明书,程序,接线和变频器参数设置说明,视频教程这段话涉及到的知识点和领域范围主要包括以下内容:MD204L......
  • python3 subprocess.getoutput(cmd) 执行linux命令进入交互模式后一直卡住了
    进入交互模式是我们预期之外的,记录一下。进入交互之后linux一直等待你的输入,所有subprocess.getoutput()就一直卡着呢~,我们加入timeout通过学习subprocess中支持timeout有:getoutput并不支持timeout参数尝试了callcheck_allcheck_output这几个方法之后并不能解决Linux交......