しっかりとしたREADMEを書こう

[sotetsuk]

他のユーザや、 将来の自分のため、 きちんとREADMEを書きましょう。

READMEでは、

1. 何のためのコードなのか
   • ここでは、Fizz Buzzルールに沿った数字の変換のため
2. どのようにインストールすれば使えるのか（開発環境、依存ライブラリ、インストールのためのコマンドなど）
   • 今回は $ make install コマンドでインストールができる
3. 簡単な例をひとまず実行するにはどうすればいいのか（エントリーポイント・実行例）

を書いておけば、ひとまず使い始めることができるはずなので、これらに重点を置いて書いてみましょう。今回のFizzBuzzプログラムの例はこちらになります。

最後に

このチュートリアルがいいなと思ったらStarお願いします！

また、ここで使ったCIやテストの構成は、テンプレート化したものが sotetsuk/python-template から利用できるので、こちらも参照してみて下さい。