开源库都会有个readme.md文件，自己写了一个小项目，也想写个readme，显得规范一点，却不知道要写点啥。
先把握一个原则，如果这个项目是个工具，就要在readme中指出该如何使用这个工具；如果是个苦，就把主要的API贴上去
在网上搜了下，GitHub上的项目大概是用Markdown工具来写的，这里先记录下，后面有空在去学下怎么用。。。。
给项目写README文档
2023-07-10
106
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《
阿里云开发者社区用户服务协议》和
《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写
侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：
给项目写README文档
相关文章
|
6月前
|
Rust
JavaScript
从零开始写一套广告组件【三】编写README.md
现在项目已经有了，但是我们还没有正式的介绍我们的项目和添加 ` License` 文件，这一章我们就一起来看看如何写一个**README.md**
64
5
5
|
8月前
|
7月前
|
存储
好看又规范的Github Readme 制作指南
本文是关于制作规范且外观吸引人的GitHub README文件的指南，包括了README的基本结构、美化技巧，以及如何使用Markdown格式、徽标和图片来增强文档的可读性和吸引力。
618
0
0
|
10月前
|
安全
网络安全
开发工具
|
10月前
|
数据可视化
算法
API
github—如何在README.md文件中添加图片
版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/qq_34173549/article/details/80551021
1、在github上的仓库建立一个存放图片的文件夹，文件夹名字随意。
10736
1
1
|
开发者
|
存储
缓存
开发工具
DVC 使用指南：项目结构中.dvcignore文件详解
.dvcignore 文件标记在遍历 DVC 项目时应排除哪些文件和目录。有时您可能希望 DVC 在处理项目时忽略某些文件。
例如，在工作区目录中处理大量数据文件时，对于dvc status这样简单的操作，您可能会遇到执行时间延长的问题。 在其他情况下，您可能
226
0
0
|
JavaScript
热门文章
最新文章
1
信用算力基于 RocketMQ 实现金融级数据服务的实践
2
git 报错 RPC failed; curl 18 transfer closed with outstanding read data remaining
3
如何在chrome上开启WebGL功能和判断目前浏览器是否支持
4
阿里云全面支持IPv6！一文揽尽4位大咖精彩演讲
5
OAuth 及 移动端鉴权调研
6
YARN中的CPU资源隔离-CGroups
7
南理工计算机学院研究生课程的评价和反思（研一上）
8
我的实用设计模式 - Simple Factory和Reflection
9
再提一下Linux系统中的MD5校验
10
checkpoint性能测试
1
有偿创建 CosyVoice2-0.5B 大模型
42
2
《深度揭秘：分布式技术如何赋能AI与鸿蒙系统集成的性能飞跃》
29
3
《深度解析：人工智能与鸿蒙系统集成中的版本管理与迭代升级》
36
4
《探索AI与鸿蒙融合的开源宝藏：这些框架你不能错过》
24
5
《鸿蒙系统下AI模型训练加速：时间成本的深度剖析与优化策略》
21
6
《深度剖析：鸿蒙系统下智能NPC与游戏剧情的深度融合》
24
7
2025年国内工单系统推荐：技术架构、场景适配与行业实践
26
8
JVM实战—2.JVM内存设置与对象分配流转
27
9
2025年AI客服机器人推荐：核心能力与实际场景应用分析
29
10
从第十批算法备案通过名单中分析算法的属地占比、行业及应用情况
30