當我們辛苦寫完一個專案並推上 GitHub 後，如果整個專案資料夾裡空蕩蕩、只有一堆看不懂的程式碼，訪客點進來可能不到三秒就會默默關掉。一個好的專案，絕對少不了靈魂推手——README.md。
簡單來說，README.md 就是你專案的「門面招牌」與「使用說明書」。它利用了 Markdown 語法，讓我們可以用最簡單的純文字，排版出漂亮的標題、粗體字、甚至是圖片與程式碼區塊。一份出色的 README 通常包含三個要素：清楚的專案宗旨、簡單易懂的安裝步驟，以及聯絡或授權資訊。
更有趣的是，GitHub 還允許我們利用與自己帳號同名的倉庫建立一個「特別的個人主頁 README」，讓你在全世界的開發者面前展示自己的技能、經歷與熱情。學會了 README 的撰寫技巧，不僅能讓你的開源專案大加分，更能打造出個人專屬的專業技術名片！
iThome鐵人賽
看影片追技術