わかりやすいREADME.mdを書く | SOTA

2014/07/31 1008 users README.md GitHub ライブラリ 過言 ユーザ

Githubなどに自分のツールやライブラリを公開するとき，README.mdは重要な役割を担っている．レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩はREADME.mdにかかっている，と言っても過言ではない．実際自分が使う側になったときも，まずREADME.mdを読んで判断していると思う． 成功しているプロジェクトを参考にしつつ，自分が実践していることをまとめておく．ここに書い... 続きを読む

使いやすいシェルスクリプトを書く | SOTA

2014/05/18 1019 users シェルスクリプト ヘルプメッセージ Usage シェル ひと

できればシェルスクリプトなんて書きたくないんだけど，まだまだ書く機会は多い．シェル芸やワンライナーのような凝ったことではなく，他のひとが使いやすいシェルスクリプトを書くために自分が実践していることをまとめておく． ヘルプメッセージ 書いてるシェルスクリプトが使い捨てではなく，何度も使うものである場合は，そのシェルの使い方としてusageを書く．これを書くのは以下の理由． チームに共有しやすい イン... 続きを読む