タグ

readmeに関するtakaesuのブックマーク (2)

  • GitHub の README.md をバッジでオシャレにできる Shields.io と dockeri.co - kakakakakku blog

    最近 GitHub リポジトリに「バッジ」を設定するため「Shields.io」というサービスを使った.README.md をオシャレにできて,とても便利だったので紹介しようと思う.ただ数年前からあったサービスらしく,今まで使ったことがなかった! shields.io バッジの種類の多さ Shields.io の特徴は「バッジの種類の多さ」で,ウェブサイトを見ると,ザッと数えて 350 個以上ある.代表的なものを挙げてみた. ビルド結果 ( CircleCI / Travis / Codeship / Wercker / Shippable / AppVeyor など ) ダウンロード回数 ( npm / Gem など ) ライセンス関連 ( GPL / MIT など ) GitHub ( issues / pull requests など ) Docker 関連 ( Pulls / Au

    GitHub の README.md をバッジでオシャレにできる Shields.io と dockeri.co - kakakakakku blog
  • わかりやすいREADME.mdを書く

    GitHubなどに自分のツールやライブラリを公開するとき,README.mdは重要な役割を担っている.レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩はREADME.mdにかかっている,と言っても過言ではない.実際自分が使う側になったときも,まずREADME.mdを読んで判断していると思う. 成功しているプロジェクトを参考にしつつ,自分が実践していることをまとめておく.ここに書いていることはあくまで(自分の中で)最低限的なものである.プロジェクトが成長していくにつれてREADMEはあるべき姿に成長していくべきだと思う. READMEの役割 README.mdには大きく2つの役割がある. プロジェクト,ツールの使い方,インストール方法 プロジェクト,ツールの宣伝 元々READMEは前者の役割しかなかったが,GitHubの仕組み上,後者の役割も徐々に重要になっている. さらに

    takaesu
    takaesu 2014/08/01
    readme driven development
  • 1