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

简介: 本文是关于制作规范且外观吸引人的GitHub README文件的指南,包括了README的基本结构、美化技巧,以及如何使用Markdown格式、徽标和图片来增强文档的可读性和吸引力。

好看又规范的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"

在文中使用

![][picture1]
目录
相关文章
|
9月前
|
Web App开发 安全 Python
Chrome RCE 漏洞复现
Google Chrome是由Google开发的免费网页浏览器,大量采用Chrome内核的浏览器同样也会受此漏洞影响。攻击者利用此漏洞,可以构造一个恶意的web页面,当用户访问该页面时,会造成远程代码执行。 由于Chrome浏览器会默认开启沙盒,可以拦截利用该漏洞发起的攻击,所以一般用户不会受到影响。
385 10
Chrome RCE 漏洞复现
|
数据可视化 算法 API
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
5182 0
|
10月前
|
机器学习/深度学习 人工智能 自然语言处理
解码语言:命名实体识别(NER)技术
解码语言:命名实体识别(NER)技术
解码语言:命名实体识别(NER)技术
|
11月前
|
数据采集 自然语言处理 算法
|
传感器 存储 Ubuntu
Azure Kinect DK + ROS1 Noetic使用教程
本文是Azure Kinect DK在Ubuntu20.04下配合ROS1 Noetic使用的教程,内容包括一键安装脚本、硬件介绍、安装SDK相关软件包、设置Udev规则、SDK基本测试、DK ROS基本测试,以及存在的一些重要缺陷和相关参考文献。教程详细指导了如何配置和使用Azure Kinect DK,提供了安装步骤和解决常见问题的方法。
860 1
Azure Kinect DK + ROS1 Noetic使用教程
|
小程序 搜索推荐 Java
【技巧】如何在github主页放一条贪吃蛇
本文介绍了如何在GitHub主页上添加贪吃蛇动画,包括设置主页、生成提交记录动画和使用GitHub Action运行工作流程。通过详细步骤和截图演示,展示了从创建仓库到最终展示SVG动画的全过程,并提供了额外的个性化展示内容和相关文章推荐,旨在为读者带来乐趣并提升GitHub页面的趣味性。
369 0
【技巧】如何在github主页放一条贪吃蛇
|
存储 前端开发 数据可视化
一文教会你 如何在Github中创建仓库?如何将多个项目放到一个仓库中管理?如何将本地项目上传到GitHub中?
这篇文章详细介绍了如何在GitHub上创建新仓库,以及如何将多个项目整合到一个仓库中进行管理。文章还提供了克隆仓库到本地、使用不同文件夹存放不同项目代码、以及将这些项目提交到远程服务器的步骤和方法。
一文教会你 如何在Github中创建仓库?如何将多个项目放到一个仓库中管理?如何将本地项目上传到GitHub中?
|
开发工具 git 开发者
【GitHub】如何在github上提交PR(Pull Request) + 多个pr同时提交、互不干扰
【GitHub】如何在github上提交PR(Pull Request) + 多个pr同时提交、互不干扰
3589 6
|
安全 Linux 网络安全
|
存储 人工智能 资源调度
【windows批处理batch】.bat文件 字符串处理相关操作(字符串定义、分割、拼接、替换、切片、查找)
【windows批处理batch】.bat文件 字符串处理相关操作(字符串定义、分割、拼接、替换、切片、查找)