工作了一段時間, 也漸漸了解文件化的重要, 比較可惜的是公司本身對這方面的觀念也蠻缺乏的. 所以只好考自己囉. 所以想說從每個project的README.md開始著手. 以下是我從網路上的相關資料再加上自己本身的經驗, 整理出一個比較適合我的 README.md template 並做個紀錄.

README.md

  1. Project Title

  1. Motivation

  1. Installing (option)

  1. Requirements

  1. Usage

  1. Options

  1. Contributors

  1. License

MIT License
# 有使用者, 必須強迫公開所使用的原始碼
GNU General Public License 2.0(GPL)
# 有使用者, 在符合條件下可不公開原始碼
GNU Lesser General Public License 3.0(LGPL)

以上這幾點可能就是我之後在建立README.md會填寫的內容.