昨天我站在了第一次拿到專案的人的角度，重新跑了一次專案的啟動流程確認目前整理出來的專案可以順利執行。
但如果真的把這個專案放到GitHub上，其他人點進來看到的可能就覺得只是一堆資料夾和程式碼，根本不知道這個專案是在做什麼，也不知道要怎麼執行。
所以從今天我要來幫我的專案建立README.md，把前面整理過的專案資訊變成一份完整的專案說明文件。

README 是什麼？

README就是 Read me的意思，它是開源專案中很重要的文件之一，通常會放在專案的根目錄中，所以其他人第一次看到這個專案時README也是最先看到的內容。
它可以讓大家快速的去了解這個專案的目的、功能、使用的技術、環境需求、資料庫還有安裝與執行方式等資訊，就像是專案的「說明書」，不用先把所有程式碼看完也可以大概知道這個專案到底在做什麼。

規劃README的骨架

在開始寫我自己的README之前，我先去參考了很多GitHub上其他人的專案。
我發現他們的README第一眼就可以吸引我繼續看下去，而且專案介紹、功能、使用技術到執行方式都整理得很清楚，容易理解可以快就知道這個專案在做什麼。
但看了那麼多README我還是不知道我的專案適合甚麼樣的骨架，所以我就問了 AI：

一份完整的README通常都會有哪些架構？那我的眼科病人與術前醫囑管理系統這個專案又適合放哪些說明？

然後我再把AI提供的建議，和前幾天整理專案記錄下來的內容做比較，整理出目前適合我的README骨架：

1. 專案介紹
2. 主要功能
3. 使用技術
4. 開發環境
5. 專案結構
6. 資料庫設計
7. 安裝與執行方式
8. 專案畫面

建立 README.md

接著因為README通常會放在專案的根目錄，所以我先在eyes_prj 建立了一個 README.md

New-Item README.md -ItemType File

然後把剛剛規劃好的骨架放進README.md
那麼.md 代表的是 Markdown，它是一種標記語言，就是我們現在打文章用的這個。

最後查看一下git status

那麼明天會來寫README裡面的內容，在建立一個有README的Commit!

參考:
https://github.com/othneildrew/Best-README-Template
https://github.com/eryajf/awesome-github-profile-readme-chinese/blob/main/README.md
https://github.com/shaojintian/Best_README_template