好看又规范的Github Readme 制作指南

这篇具有很好参考价值的文章主要介绍了好看又规范的Github Readme 制作指南。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

好看又规范的Github Readme 制作指南

README的基本结构

精心设计的 README 对于任何 GitHub 存储库都至关重要,因为它是潜在用户和贡献者的主要信息来源。 以下是创建 README 时要遵循的基本结构。

1. 标题和描述 Title and Description

首先要包含在README中的是您的项目的清晰简洁的标题和描述。

  • 这个项目是做什么的?
  • 它存在的原因是什么?

2. 目录 Table of Contents

如果README很长,请考虑包含目录以帮助读者导航到特定部分。

3. 安装 Installation

向读者提供如何安装和设置项目的指南。包括:

  • 需要安装的依赖 dependencies that need to be installed
  • 需要设置的配置 configuration that needs to be done

4. Usage 用法

说明如何使用您的项目,包括任何命令行参数或配置选项。最好有示例(example)以及效果截图。

5. Contributing 贡献

如果您欢迎其他人的贡献,请包含有关如何为您的项目做出贡献的指南。 这应该包括有关如何提交错误报告(submit bug reports)、功能请求 (feature requests)和拉取请求的信息(pull requests)。

6. License 版权信息

这部分应该包含有关项目所依据的许可证的信息。 这可以帮助用户和贡献者了解他们如何使用和修改您的代码。

7. Acknowledgments 致谢

如果您的项目建立在他人的工作之上,或者如果您得到了他人的帮助或支持,请在这部分表示感谢并提供相应的来源链接。

# Acknowledgments
We would like to thank the following individuals and organizations for their contributions to this project:

John Smith: for his help with the design of the mini pupper robot
Jane Doe: for her assistance with the implementation of the ROS2 software stack
Open Robotics: for their support of the ROS2 community and their development of the ROS2 framework
Without the help of these individuals and organizations, this project would not have been possible. Thank you all for your hard work and dedication!

README的美化

1. 制作徽标

Shields.io提供大量的标签可供使用,这就是你在Github上常见到的五颜六色的标签。

在 GitHub 中,两个徽标之间的间隔可以通过在它们之间插入   实体来实现。  是 HTML 中的空格实体,它可以在两个徽标之间添加一个空格。

2. Github Markdown格式

github上有用户创建了这个使用说明,可以帮助你了解GIthub的Markdown格式:guodongxiaren/README
以下为一些节选:

2.1 图片

使用相对路径显示图片比较方便,比如repo的目录/img下有一个picture1.jpg

![](/img/picture1.jpg "annotation")

如果图片多次使用,可以使用“复用”的办法,在文末定义

[picture1]:/img/picture1.jpg "This is a picture"

在文中使用文章来源地址https://www.toymoban.com/news/detail-717504.html

![][picture1]

到了这里,关于好看又规范的Github Readme 制作指南的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • GitHub 仓库的 README 直接播放视频

    GitHub 仓库的 README 文件,现在可以直接播放视频 上传超过10MB的视频会提示报错   https://user-images.githubusercontent.com … 1dc0b4888249.mp4  

    2024年02月09日
    浏览(41)
  • 【Ubuntu】 Github Readme导入GIF

    (1)直接转换命令: (2) 带参数命令: 参数说明: 在本地项目文件夹中打开README.md文件,然后将gif链接添加进去,至于添加的位置,我们想在哪个位置展示该gif图片就插入在哪个位置即可, 添加gif图片的代码按照以下格式构成: 然后再push即可

    2024年04月15日
    浏览(27)
  • Github 中 README 文件内各种点击跳转形式

    语法: 跳转到百度: [百度跳转](http://www.baidu.com/) 百度跳转 可以根据 🚩 相对路径 或者 🚩 绝对路径 来完成 md 文件跳转到另一个本地文件的作用。而这种链接跳转跟第一种超链接跳转是一样的, 为了能够在 Github 正常显示,均使用相对路径进行跳转 。 使用快捷键 Ctrl +

    2024年02月14日
    浏览(60)
  • GitHub上README.md文章的上传图片和图片大小尺寸

    看到别人的仓库里的readme.md有图文介绍,自己试了一下,发现并不成功,学习了一下,主要有以下几个步骤: 1.上传图片到github,并且要Commit changes 2. 返回仓库目录打开刚才上传的图片,复制此时的网页地址栏连接 例如这种格式https://github.com//***.jpg 3. 创建readme.md文件,正文

    2024年02月06日
    浏览(46)
  • 解决readme.md文件中粘贴的图片放到GitHub上无法显示问题

            GitHub的README.md文件通常无法直接引用本地文件或图片,因为GitHub的README.md是在远程服务器上渲染和显示的,无法访问本地文件系统。         要在GitHub的README.md中显示图片,你需要将图片上传到GitHub上,然后使用图片的URL进行引用。 一、将本地图片上传到Gi

    2024年02月09日
    浏览(36)
  • SimpleSniffer—ReadMe

    AppWizard has created this SimpleSniffer application for you. This application not only demonstrates the basics of using the Microsoft Foundation classes but is also a starting point for writing your application. AppWizard为您创建了这个SimpleSniffer应用程序。 此应用程序不仅演示了使用 Microsoft 基础课程的基础知识但也是编写应

    2024年02月08日
    浏览(25)
  • README

    简介 Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。 应用 当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、知乎等 编辑器 推荐使用 Typora ,官网:https://typora.io/ 什么是徽章 徽章是一种小巧精美

    2024年02月09日
    浏览(29)
  • 读程序员的README笔记07_测试(下)

    2.5.2.1. 首先应该关注代码中的高风险的区域 2.5.2.2. 那些低风险或被废弃的代码并不值得测试 3.2.1.1. 如果网络出现问题,那么测试也会失败 3.5.2.1. 使用常数种子的随机数生成器的测试将总是通过或总是失败 3.7.3.1. 注入式时间戳将让你使用模拟来精确控制测试中的时间流逝

    2024年02月05日
    浏览(46)
  • 读程序员的README笔记06_测试(上)

    4.2.3.1. 消除外部依赖性可以使单元测试快速而集中 4.5.3.1. 压力测试可暴露系统的负载能力究竟有多大,以及在过度负载下会发生什么状况 4.6.3.1. ISO认证审核委员会要求提供需求和相应的测试文件证据 5.2.1.1. 管理测试的setup和teardown 5.2.1.2. 管理测试执行和编排 5.2.1.2.1. 可

    2024年02月05日
    浏览(46)
  • 读程序员的README笔记03_变更代码

    2.2.1.1. 定义变更点 2.2.1.2. 寻找测试点 2.2.1.3. 打破依赖关系 2.2.1.4. 编写测试 2.2.1.5. 进行修改和重构 2.2.2.1. 如果需要的话,为了让测试成为可能,可以对代码进行重构 2.2.2.2. 针对现有的软件行为也要添加测试用例 2.2.2.3. 一旦竖起栅栏,你的修改点周围的区域就得到了很

    2024年02月05日
    浏览(66)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包