给项目写README文档

简介: 给项目写README文档

开源库都会有个readme.md文件,自己写了一个小项目,也想写个readme,显得规范一点,却不知道要写点啥。

先把握一个原则,如果这个项目是个工具,就要在readme中指出该如何使用这个工具;如果是个苦,就把主要的API贴上去

在网上搜了下,GitHub上的项目大概是用Markdown工具来写的,这里先记录下,后面有空在去学下怎么用。。。。

相关文章
|
5月前
|
Rust JavaScript
从零开始写一套广告组件【三】编写README.md
现在项目已经有了,但是我们还没有正式的介绍我们的项目和添加 ` License` 文件,这一章我们就一起来看看如何写一个**README.md**
53 5
从零开始写一套广告组件【三】编写README.md
|
6月前
|
存储
好看又规范的Github Readme 制作指南
本文是关于制作规范且外观吸引人的GitHub README文件的指南,包括了README的基本结构、美化技巧,以及如何使用Markdown格式、徽标和图片来增强文档的可读性和吸引力。
556 0
|
7月前
GitHub——README.md挂件如何生成
使用`shields.io`即可生成github的markdown的挂件
41 0
GitHub——README.md挂件如何生成
|
9月前
|
安全 网络安全 开发工具
【GitHub】清空 GitHub 仓库中的所有内容,只保留 `README.md` 文件
【GitHub】清空 GitHub 仓库中的所有内容,只保留 `README.md` 文件
152 2
|
9月前
|
数据可视化 算法 API
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
3726 0
github—如何在README.md文件中添加图片
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_34173549/article/details/80551021 1、在github上的仓库建立一个存放图片的文件夹,文件夹名字随意。
10659 1
|
开发者
最简单方法创建 README
最简单方法创建 README
638 0
最简单方法创建 README
|
存储 缓存 开发工具
DVC 使用指南:项目结构中.dvcignore文件详解
.dvcignore 文件标记在遍历 DVC 项目时应排除哪些文件和目录。有时您可能希望 DVC 在处理项目时忽略某些文件。 例如,在工作区目录中处理大量数据文件时,对于dvc status这样简单的操作,您可能会遇到执行时间延长的问题。 在其他情况下,您可能
|
JavaScript
在 README.md 中生成项目目录结构
在 README.md 中生成项目目录结构
1300 0
在 README.md 中生成项目目录结构

热门文章

最新文章