好看又规范的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]
目录
相关文章
|
6月前
|
缓存 Java 大数据
深入理解 Project Valhalla:值类型即将如何重塑 JVM 性能
Project Valhalla 是OpenJDK的关键项目,通过引入值类型、泛型特化等特性,显著提升JVM性能与内存效率,减少对象开销和GC压力,助力Java在高性能计算、大数据等领域实现接近底层语言的运行效率。
927 7
|
9月前
|
IDE API 开发工具
让 GitHub 个人主页更专业:用 WakaTime 实现动态代码统计
这篇文章介绍了如何使用 WakaTime 为 GitHub 个人主页添加动态代码统计,展示编码活跃度,提升专业性。通过注册账号、安装 IDE 插件、配置 GitHub 仓库和使用工作流自动更新 README 文件,实现对多种编程语言的详细统计。
835 1
让 GitHub 个人主页更专业:用 WakaTime 实现动态代码统计
|
11月前
|
机器学习/深度学习 算法 PyTorch
从零开始200行python代码实现LLM
本文从零开始用Python实现了一个极简但完整的大语言模型,帮助读者理解LLM的工作原理。首先通过传统方法构建了一个诗词生成器,利用字符间的概率关系递归生成文本。接着引入PyTorch框架,逐步重构代码,实现了一个真正的Bigram模型。文中详细解释了词汇表(tokenizer)、张量(Tensor)、反向传播、梯度下降等关键概念,并展示了如何用Embedding层和线性层搭建模型。最终实现了babyGPT_v1.py,一个能生成类似诗词的简单语言模型。下一篇文章将在此基础上实现自注意力机制和完整的GPT模型。
672 14
从零开始200行python代码实现LLM
|
11月前
|
数据采集 物联网 API
理解异步编程:从日常场景到代码逻辑
异步编程是现代高并发应用开发的核心技术之一。通过Python的asyncio库,利用事件循环机制与协程,可高效处理I/O密集型任务。相比同步模式,异步能显著减少资源闲置,如在Web请求、文件读写时“变废为宝”。文章从同步与异步对比、协程原理、事件循环机制,到实战案例(爬虫性能测试)及常见误区解决,全面解析异步编程。其适用于高并发I/O场景,但不推荐用于CPU密集型任务。掌握异步编程,如同拥有精巧工具,在合适场景下大幅提升系统性能。
673 0
|
前端开发 搜索推荐 Java
开源项目的 README.md 这样写,hr 看了都心动
开源项目的 README.md 这样写,hr 看了都心动
788 2
|
数据可视化 算法 API
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
6077 0
|
人工智能 自然语言处理 算法
魔搭上新啦! 智源千万级指令微调数据集Infinity-Instruct,Llama3.1仅微调即可接近GPT-4
智源研究院在今年6月推出了千万级指令微调数据集Infinity Instruct。Infinity Instruct在 Huggingface等平台发布后,快速到达了Huggingface Dataset的Trending第一
魔搭上新啦! 智源千万级指令微调数据集Infinity-Instruct,Llama3.1仅微调即可接近GPT-4
|
小程序 搜索推荐 Java
【技巧】如何在github主页放一条贪吃蛇
本文介绍了如何在GitHub主页上添加贪吃蛇动画,包括设置主页、生成提交记录动画和使用GitHub Action运行工作流程。通过详细步骤和截图演示,展示了从创建仓库到最终展示SVG动画的全过程,并提供了额外的个性化展示内容和相关文章推荐,旨在为读者带来乐趣并提升GitHub页面的趣味性。
725 1
【技巧】如何在github主页放一条贪吃蛇
|
XML 传感器 机器人
Isaac Sim详细安装使用教程
NVIDIA Isaac Sim 4.0版本的安装和使用教程,包括了下载、安装、配置环境、使用ROS/ROS2扩展、设置工作空间以及编译和运行示例程序的步骤。同时,还提供了Isaac Sim的架构图和USD文件格式的介绍,以及相关的资源链接和教程视频。
7068 2
Isaac Sim详细安装使用教程
|
JSON 监控 API
2024年7月免费天气API接口推荐
天气API对于开发人员来说是构建响应更快、安全性更高的应用程序的有力工具。使用天气API可以帮助开发者提供出色的用户体验,实现高效的数据管理。
1663 0