GitHub 使用指南
GitHub GuidesGitHub 仓库
  • GitHub 使用指南
  • Hello World
    • 简介
    • 什么是 GitHub?
    • 创建一个仓库
    • 创建一个分支
    • 修改并提交更改
    • 发起拉取请求
    • 合并拉取请求
  • 理解 GitHub 工作流
    • 简介
    • 创建分支
    • 提交更改
    • 发起拉取请求
    • 讨论并评审代码
    • 部署
    • 合并
  • GitHub Pages 入门
    • 简介
    • 创建你的网站
    • 做一些修改
    • 下一步
  • Git 手册
    • 简介
    • 什么是版本控制系统?
    • 什么是仓库?
    • Git 基础
    • GitHub
  • 复刻他人项目
    • 简介
    • 为项目做贡献
    • 复刻仓库
    • 克隆你所复刻的项目
    • 修改并推送
    • 发起拉取请求
  • 多多社交
    • 简介
    • 关注一个朋友
    • 查看一个项目仓库
    • 你可以做更多的事情
  • 使代码可引用
    • 简介
    • 选择你的仓库
    • 登录 Zenodo
    • 查看仓库设置
    • 发布新版本
    • 创建 DOI
    • 即将完成
  • 精通 Issues
    • 简介
    • 里程碑,标签和被指派人
    • 通知,@提及 和引用
    • 搜索
    • 概述 & 报告
    • Issues 的其他用途
  • 精通 Markdown
    • 简介
    • 什么是 Markdown?
    • 例子
    • 语法指南
    • GitHub 风味 Markdown
  • 项目文档化
    • 简介
    • 创建你的 README
    • 格式化你的 README
    • 创建你的 wiki
    • 添加内容
    • 添加页面
    • 语法高亮
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. 项目文档化

格式化你的 README

Previous创建你的 READMENext创建你的 wiki

Last updated 2 years ago

Was this helpful?

README 文件通常遵循一种格式,以便尽快将开发人员定位到项目最重要的地方。

  • 项目名称:你项目的名称是人们在向下滚动到 README 时会看到的第一件事,它是在创建 README 文件时被包含在内的。

  • 描述:接着就是你项目的描述。一个好的描述具备清楚、简短以及有重点等特点。它描述项目的重要性及其作用。

  • 目录:可选地,包括目录以允许他人快速导航特别长或特别详细的 README 文件。

  • 安装:安装是高效的 README 文件的下一部分。它告诉其他用户如何在本地安装项目。可选地,包含一个 gif 图片,以使其他人更清楚。

  • 用法:下一部分是用法,你可以在其中指导其他人在安装项目后如何使用你的项目。这也是一个包含项目截图的好地方。

  • 贡献:较大的项目通常有关于为其项目做贡献的部分,其中概述了贡献说明。有时,这是一个单独的文件。如果你有特定的贡献偏好,请解释它们,以便其他开发人员知道如何最好地为你的工作做出贡献。要了解更多有关如何帮助其他人贡献的信息,请查看为 的指南。

  • 信用:包括一个信用部分,以突出显示并链接到该项目的作者。

  • 许可证:最后,包含项目许可证的部分。有关选择许可证的更多信息,请查看 GitHub 的 !

你的 README 文件应仅包含开发者开始使用和为你的项目做出贡献的必要信息。更长的文档适合使用 wiki,如下节所述。

仓库贡献者设置指南
许可证指南