LoginSignup
4

More than 5 years have passed since last update.

READMEを書こう

Last updated at Posted at 2018-10-24

"READMEが無ければ、プログラムもまた存在し得なかっただろう"
-- A.S --

この記事の対象者・目的・意味

対象:README.mdを書かない、書いた事が無い人
結果:READMEが書けるようになるかも
時間:5分
※上記に当てはまらない人、普通に書く人は見るだけ無駄

参考

わかりやすいREADME.mdを書く
わかりやすい README 駆動開発

最初に、README.mdを書くメリット

  • ツールを作る上で必要な機能を確認できる(先に書く場合)。
  • 自分の作ったツールを再確認、再認識できる。
  • 他者
  • 使ってくれる人が増える、充実したREADMEは信頼の証

何を書くか

最低限これを書いておけば良いと思う。

  • Name : 名前
  • Description : 説明。簡潔に何ができるかを伝える。
  • status : ステータス、信頼度。
  • QuickStart : 導入の手順。
  • Usage : 使い方。クイックスタートとまとめても良き。
  • Licence : ライセンス情報。
  • Author : 作者。

その他、DEMOやFeatureなど、ものに応じて書き連ねる事がbetter。
ツールに持たせる名刺や説明書だと思ってる。

まとめ

せっかく何か作るなら第一印象も良くした方がいいよね。
というのがREADMEの役目。
まあREADME書くのにもデザインセンスいるよねー。
雑でもいいから書いてみよう!そのうちいい感じになるよきっと!
Qiitaに記事書くのも大変!だっる!!

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
4