AI 助理
文档备案控制台
开发者社区 开发与运维 文章 正文

给项目写README文档

2023-07-10 160
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 给项目写README文档

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

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

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

文章标签：
API
yum9193-41641
目录
相关文章
恬0917
|
运维 安全 数据安全/隐私保护
等保测评 —— 安全控制点
等保测评 —— 安全控制点
恬0917
340 1
征服Bug
|
网络协议 NoSQL 安全
jumpserver部署与使用
jumpserver部署与使用
征服Bug
1593 0
听风de歌
|
搜索推荐 IDE 开发工具
IDEA自定义右键菜单
IDEA自定义右键菜单
听风de歌
3195 1
万俟淋曦
|
缓存 测试技术 编译器
[Eigen中文文档] 稠密矩阵分解函数对比
本文介绍了 Eigen 为各种方阵和过约束问题提供的稠密矩阵分解的速度比较。
万俟淋曦
476 0
ReadThroughLife
|
JSON 前端开发 Java
RestfulToolKit：便捷的 IDEA 接口测试神器
RestfulToolKit：便捷的 IDEA 接口测试神器
ReadThroughLife
3153 0
RestfulToolKit：便捷的 IDEA 接口测试神器
店家小二
|
Prometheus 监控 Cloud Native
Prometheus VS InfluxDB
前言 除了传统的监控系统如 Nagios，Zabbix，Sensu 以外，基于时间序列数据库的监控系统随着微服务的兴起越来越受欢迎，比如 Prometheus，比如 InfluxDB。gtt 也尝试了一下这两个系统，希望能找到两者的差别，为以后选型提供一些帮助。
店家小二
9976 0
吃番茄长大的西红柿
|
机器学习/深度学习 算法 PyTorch
深度学习在人脸识别技术中的最新进展
深度学习在人脸识别技术中的最新进展
吃番茄长大的西红柿
648 2
nine很菜
|
人工智能 NoSQL Java
SpringAI做对了什么
SpringAI 在 AI 编程领域延续了Spring的诸多优势，从易于集成、到通用API设计进行模型切换等。
nine很菜
755 2
SpringAI做对了什么
快捷资讯
|
开发者
UniAD 加入 Lidar 模态
解决2：检测和跟踪需要分开训练。uniad 原作者使用的是 bevformer 预训练的检测权重。因此，先要写一个检测代码，作单帧检测任务。然后将训练好的检测权重 load 到跟踪的代码中。
快捷资讯
274 0
No8g攻城狮
|
Java 微服务 Spring
【Spring Cloud】spring cloud 调用feign请求超时 feign.RetryableException: Read timed out executing POST
【Spring Cloud】spring cloud 调用feign请求超时 feign.RetryableException: Read timed out executing POST
No8g攻城狮
2767 0

热门文章

最新文章

  • 1
    云数据库POLARDB优势解读系列文章之①——10分钟入门
  • 2
    mysql远程连接数据库很慢
  • 3
    如何轻松地 rip 3D Blu-ray：详细步骤指南
  • 4
    深度学习中的优化算法及其应用
  • 5
    【错误记录】PyCharm 中从 GitHub 中 Clone 代码到本地报错 ( OpenSSL SSL_read: Connection was reset, errno 10054 )
  • 6
    Struts2的工作流程
  • 7
    Make Connection NON Load Balance But Failover to RAC
  • 8
    一句代码实现批量数据绑定[上篇]
  • 9
    Twitter投资高端智能耳机厂商Muzik
  • 10
    如何使用 RDO 和 ADO 对象的 GetChunk 和 AppendChunk 方法
  • 1
    2026年OpenClaw(Clawdbot)极速部署与OpenClaw Skills生态运维指南
    71
  • 2
    OpenClaw 财富密码？OpenClaw部署+Skill AI量化炒股，全天自动盯盘找黑马
    232
  • 3
    2026年OpenClaw/Clawdbot阿里云一键部署与72个必备OpenClaw Skills通关指南
    124
  • 4
    2026年零基础、零技术安装OpenClaw(Clawdbot) 部署 OpenClaw Skills喂饭级教程
    204
  • 5
    2026年阿里云OpenClaw(Clawdbot)部署与OpenClaw Skills实战指南
    116
  • 6
    2026年OpenClaw（原Clawdbot）零基础入门指南：阿里云部署+Skills安装流程
    137
  • 7
    藏太深！阿里云服务器价格计算器，90%人不知道入口在哪
    33
  • 8
    阿里云服务器价格计算器入口链接：2026升级为配置报价器
    35
  • 9
    JDK 21安装教程 Windows版详细步骤+环境变量验证（含java/javac/java -version检测）
    167
  • 10
    阿里云无影云电脑计算套餐是什么？120小时/月够用吗？
    152

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    第五届伏魔挑战赛如约来袭，诚邀各路高手来战！