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

在文中使用

![][picture1]