READMEを書こう
0 likes466 views
「新しいLinuxの教科書」を読む会 オンライン #2 で行ったREADMEについてのプレゼン資料です。 https://linuxbook.connpass.com/event/178366/
READMEを書こう
- 2. 自己紹介 名前: 三宅 英明 Twitter: @mollifier 神戸のプログラマ
- 3. シェルスクリプト
- 6. シェルスクリプト 公開
- 8. READMEとは
- 10. READMEとは
- 11. READMEとは
- 20. READMEの目的
- 25. READMEに何を書くか
- 39. READMEに何を書くか 1行で無理なら必要なコマンドを全部書く $ git clone https://github.com/tool.git ~/tool $ cd ~/tool $ ./setup.sh
- 45. READMEに何を書くか # ~/workをブックマークに追加する $ bookmark add work ~/work $ cd ~/tmp # workという名前で~/workに移動できる $ bookmark cd work
- 52. READMEに何を書くか 典型的な例 Install (インストール) Usage (使用方法) Option (オプション) Configuration (設定方法)
- 56. READMEを書く時のコツ
- 69. まとめ
- 70. まとめ READMEは大事
- 77. まとめ ありがとうございました