什麼是 readme 文件？
自述文件是用戶在查看儲存庫時首先看到的內容。它讓用戶了解專案的內容、使用的語言、條款和條件、您的專案可以做什麼、顯示正在執行的應用程式的螢幕截圖等。
為什麼它如此重要？
該用戶可能是招募人員、您未來的老闆或客戶。因此，需要注意的是，專案的自述文件應該回答專案的內容、原因和方式。
因此，重要的是要包含最重要的訊息，對專案和所使用的技術堆疊進行清晰的描述，並提供可能不適合 README 文件的連結和進一步說明，以避免不必要地搜尋所有其他文件。可能會導致用戶失去興趣並轉向下一個潛在員工。
編寫有關該專案的良好文件是多麼重要，我怎麼強調都不為過。使用者不僅在尋找有關專案本身的訊息，而且還看到您的文件技能和對細節的關注，這可以讓您更接近找到工作。
如果您讀過我的其他文章，您可能已經注意到，除了程式設計之外，學習其他技能對我的職業生涯有多麼重要，這些技能最終幫助我找到了工作。良好的文件就是其中之一。
自述文件中應包含哪些內容？
以下是一些可以幫助您的指導性問題：
-
該專案是關於什麼的？
-
為什麼開發它，你的動機是什麼？
-
它解決什麼問題？
-
你學到了什麼？
-
是什麼讓您的專案脫穎而出？
我將向您展示如何將這些問題轉換為文字。
可能的結構
描述
專案的目的和描述，以便閱讀您的作品集的人可以在閱讀專案資訊的前幾秒鐘內了解該專案。
技術堆疊
技術堆疊，包括您的專案使用的程式語言、程式庫和框架（例如：Python、React 等）。如果您有使用外部公共 API 的前端應用程式，請提及這一點。
設計
與專案相關的使用者介面範例。如果專案有使用者介面，您可以插入使用者介面的 GIF、影片或圖像。
如果它是在終端上執行的應用程式，您可以建立一個 GIF 來展示如何使用它。這有助於了解如何與應用程式互動以及人們在執行專案時會看到什麼。
特徵
如果您的專案有很多功能，您應該加入“功能”部分並在此處列出它們。
如何執行專案
有關如何設定、執行和使用該專案的說明。如果有人想從頭開始該專案，這很好，他們應該在專案的自述文件中找到他們需要了解的所有內容，而不需要您的任何幫助。
如果很簡單，您可以將其包含在自述文件中。如果說明較長，您也可以參考專案中的另一個文件。
您還應該使用 Netlify 來託管您的專案，以便使用者可以打開已部署的應用程式並立即使用它來查看它是如何運作的。 （請記住，並非每個查看您 GitHub 個人資料的招募人員都充分了解如何在本地建立專案。）
如何設計自述文件的樣式？
README.md中的.md副檔名代表 Markdown，這是一種輕量級標記語言，具有簡單的文字格式化語法。它是一種非常簡單的語言，用於為 GitHub 建立美觀且美觀的自述文件。
因此，您可以使用典型的 Markdown 語言，例如
# Heading 1
## Heading 2
### Heading 3
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
⋅⋅1. Ordered sub-list
4. And another item.
[I'm an inline-style link](https://www.google.com)
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
原文出處：https://dev.to/yuridevat/how-to-create-a-good-readmemd-file-4pa2
1) --- 會變成分隔線（上一行必須是空白）
2) # 會變成一級標題
3) ## 會變成二級標題
4) ### 會變成三級標題
5) **粗體文字**會顯示粗體文字
6) ```當第一行與最後一行會顯示程式碼
7) 請搜尋 Markdown 語法，了解各種格式