當你不知道readme怎麼寫的時候應該是請教你的主管會比較好
首先readme是用mardown語法->markdown語法有哪些格式餵狗都找得到。
內容的部分你也打出來了

是要寫介紹這個專案程式相關簡介(目的 功能 用途 使用方法 來源)
也就是說，你就用markdown語法下好主標。接著根據主標分幾個副標把該打的打上去就好。
大概像這樣吧

回復文章：主旨

此回答的目的是為了示範如何使用markdown語法建立一個簡單的readme文件，基本上就把想打的事情打上來，然後把內容跟主管討論(若真的不熟)

我自己寫的時候會注意的東西

1. 簡單介紹
   1. 要讓一個不知道這在幹嘛的人，大概知道在幹嘛
   2. 用到了什麼語言、工具等等
2. 內容物
   1. 運用的工具/語言
   2. 運用的資源(video or photo)
3. 執行環境↑上面是概括，這邊要詳細講版本，以及一些細節
   1. 細節
   2. 細節
4. 安裝步驟
   1. 怎麼安裝你剛剛說的執行環境
5. 支援
   1. 遇到麻煩時可以問誰，基本上你是開發人員就填自己(X)，要走就填主管或不寫(O)
   2. 可以參考哪些資料若遇到麻煩的話
6. 須注意的特殊事項
   1. 什麼東西絕對不要動，或要動絕對要注意什麼之類的
7. 使用者操作手冊
   1. 這程式給使用者後有什麼操作流程之類的

結語

固定會寫些抱怨的東西

我的話會這樣啦，但老實說我也沒很常做這些東西，就只是參考用而已，每個地方都有最適合的格式，真不知道怎寫最好問過主管，知道他所要的內容，投其所好絕對比自己覺得完美好。

話說IT邦幫忙也是用markdown語法，你可以看看
https://ithelp.ithome.com.tw/markdown

說真的，我就直接講白好了。

你還算半桶水。
為何會這樣說?
一個不知道怎麼寫readme的，跟不想寫readme的人。是視全不一樣的
因為可以馬上理解 readme 要怎麼寫的人，一定是經驗很豐富的。
知道會碰上什麼要運行什麼要做啥....
寫個README根本不可能不會不知道怎麼寫。

最多是懶的寫。(我就是這樣的人...很懶的寫，但不得不寫)

一般來說，README大約就幾個大項

1. 應用的名稱、版本、開發群或公司名，連結或連絡方式。
2. 適合的系統、語言、可能性版本
3. GIT的來源。(如果有)
4. 安裝方式、過程及處理。
5. 設定的調整
6. 需要注意的事項(可有可無)

就約這幾個大項。

現在比較少寫對應的函式使用方法及方式。就算要。
只要你程式內的註解有寫好。其實都有對應的工具幫你生成的。

註解一般就大約如下

    /**
     * Notes:方法說明
     * User: 開發人員
     * Date: 開發日期
     * @param 傳入參數的說明(沒參數可無)
     * @return 回傳的說明(沒回傳可無)
     * @throws 對應的來源類別(這不一定要有，不過我大多是會留下，寫說明方便連結)
     */

是GitHub，不是GitHib喔～

讀作「ㄍ一 ㄏㄚ ㄅ」(t是舌尖頂一下上齒齦，幾乎聽不到聲音，b的發音也很輕)

不要讀成「居哈ㄅ」。