README.md编写
一、摘要
项目一般会有个描述文件,对于项目的代码来讲,这个描述就是README.md文件,可以描述各模块功能、目录结构等。该文件可以方便让人快速了解项目的代码结构和功能。当然,若要深层次的了解项目,就得看项目总体的需求规格说明书、概要设计说明书、详细设计说明书了。
二、语法
一个md文件如下,有标题,标题下可以有代码、说明、链接等。
2.1 标题语法
标题用“#”来标识,几个#就代表几级标题,标题和#之间有个空格。比如:“# 一级标题”、“## 二级标题”、“### 三级标题”。其中一级标题最大。
2.2 列表语法
原点符:一个“*”和一个空格会变成原点符,具体如下:

若用tab键和*以及空格,则会显示不同的效果,具体如下:

可以看到*+空格 后的内容会将换行符转化成空格,且每一级显示原点不一样。
2.3 文字样式
斜体用“*”或“_”包围,粗体用“**”或“__”包围,粗斜体用“***”或“___”包围,删除线用“~~”包围。
2.4 引用
在内容前面加“>”,引用可以嵌套,具体如下:

2.5 代码块
对于单行代码用“`”包裹,多行代码则用“```”包裹。具体如下:
![]()

2.6 分割线
三个以上的“*”或“_”或“-”就可以产生一条分割线。
2.7 链接
链接的文字用[]包围,链接的地址用[]后的()包围,具体如下:

点击链接后就会自动跳转括号内的地址,[]内的描述可以是中文也可以是英文。
相关文章:
README.md编写
一、摘要 项目一般会有个描述文件,对于项目的代码来讲,这个描述就是README.md文件,可以描述各模块功能、目录结构等。该文件可以方便让人快速了解项目的代码结构和功能。当然,若要深层次的了解项目,就得看项目总体的需…...
软件设计证书倒计时28天
从一个月前的果断报考软件设计证书,我没有后悔过。 软件设计证书一个月备考情况: 现在做选择题的正确率可以达到65%。是重复做过两遍历年真题。 接下来是继续做模拟题。 大题的题型基本是都知道, 第一题数据流图,第二题er图&…...
程序员基础的硬件知识(cpu、主板、显卡、内存条等)
一、综合简介 cpu:负责运算数据,就等于你的大脑运算速度。 显卡:本来没有显卡,后来因为大家对图片要求越来越高,视频要求越来越高,啥都让cpu算太累了,于是分出来一个,专门用来计算…...
优化Google Cloud Storage大文件上传和内存溢出
背景 我们的项目每天都会并行上传好几万份文件到下游的GCP Cloud Storage,当文件比较大时,会采用GCP的可续上传方案,通过把文件切分成多个数据块,分多次HTTP请求上传到GCP Bucket,具体可参考https://cloud.google.com…...
chatGPT的prompt技巧
Prompt 公式是 Prompt 的特定格式,通常由三个主要元素组成: 任务:明确而简洁地陈述 Prompt 要求模型生成的内容。指令:模型在生成文本时应遵循的指令。角色:模型在生成文本时应扮演的角色。 指令 Prompt 技术 指令 …...
【华为OD机试 2023最新 】统一限载货物数最小值(C语言题解 100%)
文章目录 题目描述输入描述输出描述备注用例题目解析代码思路C语言题目描述 火车站附近的货物中转站负责将到站货物运往仓库,小明在中转站负责调度2K辆中转车(K辆干货中转车,K辆湿货中转车)。 货物由不同供货商从各地发来,各地的货物是依次进站,然后小明按照卸货顺序依…...
ios 在windows chrome 联调
必要条件 1、iOS设备、数据线 2、Node.js 环境 3、Chrome 浏览器 4、电脑登录iTunes 5、手机 Safari 浏览器环境准备 1、安装Node环境参考Node安装的教程,确保终端输入node时可正常使用 2、安装 scoope 以及相关配置为了安装后续需要用的工具 remotedebug-ios-web…...
干翻Mybatis源码系列之第六篇:Mybatis可选缓存概述
前言 一:后续Mybatis我们会研究那些内容? Mybatis核心运行源码分析(前面系列文章已经探讨过) Mybatis中缓存的使用 Mybatis与Spring集成 Mybatis 插件。 Mybatis的插件可以对Mybatis内核功能或者是业务功能进行拓展,…...
如何调教ChatGPT
调教ChatGPT需要进行以下步骤: 收集语料库 首先需要准备一定量的自然语言数据,这些数据可以是文本、对话、新闻等。语料库越大,模型效果通常会越好。 数据预处理 对于收集到的原始语料库需要进行一定的预处理操作,比如去除噪声…...
记一次我的漏洞挖掘实战——某公司的SQL注入漏洞
目录 一、前言 二、挖掘过程 1.谷歌语法随机搜索 2.进入网站 3.注入点检测 3.SQLMAP爆破 (1)爆库 (2)爆表 (3)爆字段 三、总结 一、前言 我是在漏洞盒子上提交的漏洞,上面有一个项目叫…...
代码随想录二刷复习 day1 704二分查找 27 移除元素 977 有序数组的平方
代码如下 func search(nums []int, target int) int { left : 0 right : len(nums)-1 for left < right { middle : (leftright)/2 if target < nums[middle] { //因为上面的判断条件是left < right,所以左右两个边界的值最后都能取到,而此…...
第16章 指令级并行与超标量处理器
处理器体系结构的超标量实现是指常见指令--整数与浮点算术、加载存储和条件分支--可以同时启动,但独立执行。 16.1 概述 超标量方法的本质是能在不同的流水线中独立地并发地执行指令。 在传统的标量组织结构中,其并行性是通过允许许多指令在同一时间处…...
JavaWeb ( 三 ) Web Server 服务器
1.5.Web Server服务器 Web Server 服务器是一种安装在服务器主机上的应用程序, 用于处理客户端(Web浏览器)的请求,并返回响应内容。服务器使用HTTP(超文本传输协议)与客户机浏览器进行信息交流。 简单说就是将http协议的信息翻译成对应开发语言可以处理的对象信息。…...
2.6 浮点运算方法和浮点运算器
学习目标: 以下是一些具体的学习目标: 理解浮点数的基本概念和表示方法,包括符号位、指数和尾数。学习浮点数的运算规则和舍入规则,包括加、减、乘、除、开方等。了解浮点数的常见问题和误差,例如舍入误差、溢出、下…...
第一次找实习, 什么项目可以给自己加分(笔记)
什么样的项目能简历加分、对找工作有帮助 基本特征: 一个特征是“硬核基础软件”,另一个为很实用的APP。 硬核基础软件 独立实现一个操作系统的kerne内核(操作系统的内部引擎) 北美计算机名校会让学生用一个学期的时间实现一个…...
FPGA/Verilog HDL/AC620零基础入门学习——8*8同步FIFO实验
实验要求 该项目主要实现一个深度为8、位宽为8bit的同步FIFO存储单元。模块功能应包括读控制、写控制、同时读写控制、FIFO满状态、FIFO空状态等逻辑部分。 该项目由一个功能模块和一个testbench组成。其中功能模块的端口信号如下表所示。 提示: (1&a…...
shell脚本
shell函数 函数分类: 系统函数 自定义函数 常用系统函数: basename 从指定路径中获取文件名 dirname 从指定路径中获取目录名,去掉文件名 自定义函数 # 函数的定义 函数名 () { 命令 # 使用$n获取函数的参数 [return 返回…...
不部署服务端调用接口,前端接口神器json-server
简介 json-server 是一款小巧的接口模拟工具,一分钟内就能搭建一套 Restful 风格的 API,尤其适合前端接口测试使用。 只需指定一个 json 文件作为 api 的数据源即可,使用起来非常方便,30秒入门,基本上有手就行。 进阶…...
国产化:复旦微JFM7K325T +华为海思 HI3531DV200 的综合视频处理平台
板卡概述 TES714 是自主研制的一款 5 路 HD-SDI 视频采集图像处理平台,该平台采用上海复旦微的高性能 Kintex 系列 FPGA 加上华为海 思的高性能视频处理器 HI3531DV200 来实现。 华为海思的 HI3531DV200 是一款集成了 ARM A53 四核处理 器性能强大的神经网络引擎…...
Ceph入门到精通- stderr raise RuntimeError(‘Unable to create a new OSD id‘)
/bin/podman: stderr raise RuntimeError(Unable to create a new OSD id) podman ps |grep osd.0 podman stop osd.0 容器id 重新添加osd.0 集群目录 cd /var/lib/ceph/e8cde810-e4b8-11ed-9ba8-98039b976596/1109 ls1110 rm -rf osd.01111 ceph orch daemon add osd…...
Android 代码格式化终极指南:从缩进到导入排序的完整教程 [特殊字符]
Android 代码格式化终极指南:从缩进到导入排序的完整教程 🚀 【免费下载链接】android-guidelines Architecture and code guidelines we use at ribot when developing for Android 项目地址: https://gitcode.com/gh_mirrors/an/android-guidelines …...
无锁队列(Lock-Free Queue)
无锁队列原理 无锁队列(Lock-Free Queue)是一种基于无锁编程(Lock-Free Programming)技术实现的并发数据结构。它的核心思想是: 1.基础原理 使用 CAS(Compare-And-Swap,比较并交换)等…...
ESP32语音唤醒实战:VADNet模型配置与防截断缓存机制详解(附代码)
ESP32语音唤醒实战:VADNet模型配置与防截断缓存机制详解(附代码) 在智能语音设备开发中,语音唤醒功能的稳定性直接影响用户体验。ESP32作为物联网领域的热门芯片,其内置的VADNet语音活动检测模型为开发者提供了强大的工…...
FOC无刷电机驱动笔记:从三相电流到旋转坐标的数学之旅
1. 从三相电流到旋转坐标:FOC控制的核心数学工具 第一次接触FOC(Field Oriented Control)无刷电机控制时,最让我头疼的就是那些复杂的坐标变换。三相电流、克拉克变换、帕克变换...这些名词听起来就像天书。直到我用STM32F407VET6…...
东南大学论文模板终极指南:告别格式烦恼,专注学术创作
东南大学论文模板终极指南:告别格式烦恼,专注学术创作 【免费下载链接】SEUThesis 项目地址: https://gitcode.com/gh_mirrors/seu/SEUThesis 每到毕业季,无数东南大学学子都面临同样的困境——花费数周时间反复调整论文格式…...
Qwen2.5-0.5B-Instruct实战:Python调用接口代码实例
Qwen2.5-0.5B-Instruct实战:Python调用接口代码实例 想快速上手一个轻量级但功能强大的AI模型吗?今天我们来聊聊阿里开源的Qwen2.5-0.5B-Instruct模型,并手把手教你如何用Python调用它的接口。这个模型虽然参数只有5亿,但在指令遵…...
【NOIP】1999真题解析 luogu-P1015 回文数 | GESP四、五级以上可练习
NOIP 1999 普及组真题,主要考察字符串处理、高精度加法以及任意进制的进位规则。解题的核心是将数字看作字符串处理,在循环累加中验证回文特征。适合GESP四、五级以上考生练习。题目难度⭐⭐☆☆☆,洛谷难度等级普及−。 luogu-P1015 [NOIP …...
Windows 11系统优化解决方案:Win11Debloat完全指南
Windows 11系统优化解决方案:Win11Debloat完全指南 【免费下载链接】Win11Debloat A simple, lightweight PowerShell script that allows you to remove pre-installed apps, disable telemetry, as well as perform various other changes to declutter and custo…...
告别ST-Link!用CH347+OpenOCD给STM32烧录程序,保姆级配置教程(含常见报错解决)
低成本玩转STM32:用CH347OpenOCD实现高效烧录的完整指南 在嵌入式开发领域,ST-Link调试器一直是STM32系列芯片的标准搭档,但其价格往往让个人开发者、学生群体望而却步。有没有一种既经济实惠又功能完备的替代方案?CH347这款多功…...
树莓派5 MIPI摄像头配置与实战:从CSI/DSI接口到图像采集
1. 树莓派5的MIPI摄像头接口解析 树莓派5最大的硬件改进之一就是将CSI和DSI接口合并为两个通用的CSI/DSI(MIPI)端口。这种设计让接口使用更加灵活,你可以根据需要自由选择连接摄像头或显示屏。这两个接口都采用15针FPC排线连接器,…...

