開源 README 模板生成器
生成一份彰顯認真開源專案的 README —— 徽章、貢獻指南、許可說明和清晰結構。
開源專案在爭奪注意力,而 README 就是那段推介。有清晰概述、貢獻指南和許可說明的專案讀起來像在維護、值得信任;只有一行文字的專案讀起來像被遺棄,無論程式碼多好。
這個工具生成為開源而設的結構化 README —— 概述、安裝、用法、貢獻指南和許可章節,併為徽章留佔位。你得到貢獻者期望的慣例,讓你的專案贏得其程式碼應得的 star 和 PR。
對應工具
📘README 生成
把專案要點變成一份規範、完整的 README.md。
常見問題
開源 README 該包含什麼? +
概述、安裝、用法、貢獻指南和許可說明 —— 外加徽章。工具會生成這整套結構。
會加貢獻指南嗎? +
會。它會起草貢獻指南,讓新人知道如何參與。
能為全球受眾翻譯嗎? +
能 —— 搭配翻譯工具,提供多語言版 README。