建立 README

GitHub 概念入門

Jasmin Ludolf

Content Developer, DataCamp

編輯 README

編輯 README

編輯 README

Markdown

編輯 vs. 預覽

標題

標題

標題

文字格式

超連結

超連結

圖片

撰寫 README

• 內容需具描述性
  • 讓任何人都看懂專案
• 列出版本庫內容
• 清楚向他人說明專案

README 基本要素

• 標題
• 技術說明
  • 為什麼？
• 流程說明
  • 為什麼？
• 目錄

README 進階內容

• 專案起源
• 動機
• 侷限
• 挑戰
• 想解決的問題
• 預期用途
• 致謝

一起來練習吧！

GitHub 概念入門