write-readme

README：簡潔に

README を書くときは、簡潔にしてください。ライセンスやコントリビューションのセクションは含めないでください。

コマンドラインインターフェースの使い方を示すチートシートを必ず掲載してください。CLI はコードブロック内に記載し、その目的を示す短いコメントを直前に1行添えてください。

構成

すべてのコマンド呼び出しを1つのコードブロックにまとめ、それぞれの直前に1行コメントを付けてください。

各例を別々のコードブロックにしたり、個別の説明文や見出しを付けたりしないでください。

# find files where tags include "python"
islandiguana ./notes '.tags[] == "python"'

# find files up to 1 level deep
islandiguana --max-depth 1 ./notes '.tags[] == "python"'

# delete a front matter key from all matched files
islandiguana ./notes '.filetype == "product"' --mutate 'del(.filetype)'

説明文はコードブロックの前後に置き、ツールの概要や、読者が推測できないルールを説明してください。

コマンドの間に説明文を挟まないでください。

出力

出力例の掲載は任意であり、ほとんどのチートシートでは掲載しません。

掲載する出力は、実際のものでなければならないというルールが適用されます。ただし、出力例の掲載が必須になるわけではなく、各コマンドに出力ブロックを付ける理由にもなりません。

JSON レコードや解析エラーなど、コマンドの結果が要点となる場合は、その結果を示してください。