创建 README

GitHub 概念入门

Jasmin Ludolf

Content Developer, DataCamp

编辑 README

足球分析仓库视图

GitHub 概念入门

编辑 README

足球分析仓库视图，突出显示 README 文件

GitHub 概念入门

编辑 README

足球分析仓库视图，突出显示编辑 README 的铅笔图标

GitHub 概念入门

Markdown

README 文件视图

GitHub 概念入门

编辑 vs 预览

README 文件视图，突出显示编辑和预览选项卡

GitHub 概念入门

标题

Markdown 编辑页视图，包含最大级标题的语法

Markdown 预览页视图，显示最大级标题

GitHub 概念入门

标题

Markdown 编辑页视图，包含六种标题类型的语法

Markdown 预览页视图，显示六种标题类型

GitHub 概念入门

标题

Markdown 编辑页视图，包含六种标题类型的语法]

Markdown 预览页视图，显示六种标题类型，并用箭头指向一级和二级标题下的分隔线

GitHub 概念入门

文本格式

Markdown 编辑页视图，包含加粗和斜体的语法

Markdown 预览页视图，显示加粗和斜体文本

GitHub 概念入门

超链接

Markdown 编辑页视图，包含超链接语法

Markdown 预览页视图，显示超链接

GitHub 概念入门

超链接

点击超链接的动画视图

GitHub 概念入门

图片

将图片拖入 Markdown 文件并由 GitHub 自动渲染语法的动画视图

GitHub 概念入门

撰写 README

  • 需具描述性
    • 让任何人都能理解项目
  • 列出仓库内容
  • 清晰向他人说明项目

打开书本的插图

GitHub 概念入门

README 基础

  • 标题
  • 技术说明
    • 原因？
  • 流程说明
    • 原因？
  • 目录
GitHub 概念入门

README 进阶

  • 项目缘起
  • 动机
  • 局限
  • 挑战
  • 期望解决的问题
  • 预期用法
  • 致谢
GitHub 概念入门

Passons à la pratique !

GitHub 概念入门

Preparing Video For Download...