开源库都会有个readme.md文件，自己写了一个小项目，也想写个readme，显得规范一点，却不知道要写点啥。
先把握一个原则，如果这个项目是个工具，就要在readme中指出该如何使用这个工具；如果是个苦，就把主要的API贴上去
在网上搜了下，GitHub上的项目大概是用Markdown工具来写的，这里先记录下，后面有空在去学下怎么用。。。。
给项目写README文档
2023-07-10
105
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《
阿里云开发者社区用户服务协议》和
《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写
侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：
给项目写README文档
相关文章
|
10月前
|
开发工具
git
|
6月前
|
Rust
JavaScript
从零开始写一套广告组件【三】编写README.md
现在项目已经有了，但是我们还没有正式的介绍我们的项目和添加 ` License` 文件，这一章我们就一起来看看如何写一个**README.md**
62
5
5
|
7月前
|
存储
好看又规范的Github Readme 制作指南
本文是关于制作规范且外观吸引人的GitHub README文件的指南，包括了README的基本结构、美化技巧，以及如何使用Markdown格式、徽标和图片来增强文档的可读性和吸引力。
609
0
0
|
10月前
|
安全
网络安全
开发工具
|
10月前
|
数据可视化
算法
API
github—如何在README.md文件中添加图片
版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/qq_34173549/article/details/80551021
1、在github上的仓库建立一个存放图片的文件夹，文件夹名字随意。
10727
1
1
|
开发者
|
存储
缓存
开发工具
DVC 使用指南：项目结构中.dvcignore文件详解
.dvcignore 文件标记在遍历 DVC 项目时应排除哪些文件和目录。有时您可能希望 DVC 在处理项目时忽略某些文件。
例如，在工作区目录中处理大量数据文件时，对于dvc status这样简单的操作，您可能会遇到执行时间延长的问题。 在其他情况下，您可能
224
0
0
|
存储
机器学习/深度学习
缓存
DVC 使用指南：项目结构
在您的工作空间中使用 dvc init 将开始一个 DVC 项目，包括内部的 .dvc/ 目录。 从那里开始，您将创建和管理不同的 DVC 文件，并在使用 DVC 并进行数据科学实验时占据缓存。
689
0
0
|
JavaScript
热门文章
最新文章
1
Mac 上 iterm2 和 VSCode 终端中的字体设置建议
2
从零开始做逆变器系列 ( 二 ): 单极性、双极性、单极性倍频SPWM
3
信用算力基于 RocketMQ 实现金融级数据服务的实践
4
ubuntu如何实现访问实际网络中windows共享文件夹
5
springboot之使用redistemplate优雅地操作redis
6
阿里云服务器价格表2022更新（多CPU内存配置报价）
7
向AI医疗再次进军，DeepMind利用人工智能预测急性肾损伤
8
蒙特卡罗方法 python 实现2
9
[ASP.NET]国外的几款菜单似的导航栏
10
mm_struct
1
基于模糊PID控制的六步逆变器供电无刷直流电机调速simulink仿真
21
2
使用 Python 合并微信与支付宝账单，生成财务报告
18
3
泵浦光与斯托克斯光相遇耦合效应的matlab模拟与仿真
22
4
一、MyBatis简介：MyBatis历史、MyBatis特性、和其它持久化层技术对比、Mybatis下载依赖包流程
92
5
《DeepSeek成本“瘦身”秘籍：云原生技术全解析》
31
6
《DeepSeek牵手云原生，流量管理玩出新高度》
27
7
《DeepSeek借云原生容器化，解锁产品迭代新速度》
26
8
《云原生技术：DeepSeek分布式推理的效能倍增器》
20
9
《深度解析DeepSeek-M8：量子经典融合，重塑计算能效格局》
32
10
JVM简介—2.垃圾回收器和内存分配策略
29