MarkDown/README.md
2024-05-17 13:39:09 +08:00

1.2 KiB
Raw Blame History

Markdown教學

Markdown 介紹

Markdown 是目前非常普遍用來撰寫文檔的語言,一開始的目標就是使用 「易讀易寫的純文字格式編寫文件」

常見的如在Github的README.md 此就是Markdown格式

若之後在面試前需要放個人專案很多都會放上GitHub的網址進行查詢

以下將以如何書寫各自專案的README並進行專案介紹

Markdown 優勢

如實驗室常會去拜訪YoloV8 Github:

可透過網址直接供人查詢到專案大綱,且易於介紹

實際演練

創建一個儲存庫(專案)

點擊wiki

由於Wiki的語法也是Markdown故可直接透過Wiki進行書寫
Wiki是做專案相關文件如規劃書、驗收文件、操作手冊等
這邊只是用這個製作README

即可開始書寫README

詳細內容包含如何上傳圖片至網路及git的用法都可以透過PPT進行查看