“さらに自分の場合は，README.mdを簡単な設計書としても使う．新しくツールやライブラリを書き始めるときは，まずREADME.mdを書く．Usageを書くことでツールの簡単なインターフェース，オプションを定義する”

lesamoureuses のブックマーク 2014/08/01 11:31

<blockquote class="hatena-bookmark-comment"><a class="comment-info" href="https://b.hatena.ne.jp/entry/212170313/comment/lesamoureuses" data-user-id="lesamoureuses" data-entry-url="https://b.hatena.ne.jp/entry/s/deeeet.com/writing/2014/07/31/readme/" data-original-href="https://deeeet.com/writing/2014/07/31/readme/" data-entry-favicon="https://cdn-ak2.favicon.st-hatena.com/64?url=https%3A%2F%2Fdeeeet.com%2Fwriting%2F2014%2F07%2F31%2Freadme%2F" data-user-icon="/users/lesamoureuses/profile.png">わかりやすいREADME.mdを書く</a><br><p style="clear: left">“さらに自分の場合は，README.mdを簡単な設計書としても使う．新しくツールやライブラリを書き始めるときは，まずREADME.mdを書く．Usageを書くことでツールの簡単なインターフェース，オプションを定義する”</p><a class="datetime" href="https://b.hatena.ne.jp/lesamoureuses/20140801#bookmark-212170313"><span class="datetime-body">2014/08/01 11:31</span></a></blockquote><script src="https://b.st-hatena.com/js/comment-widget.js" charset="utf-8" async></script>

このブックマークにはスターがありません。
最初のスターをつけてみよう！

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

deeeet.com2014/08/01

GitHubなどに自分のツールやライブラリを公開するとき，README.mdは重要な役割を担っている．レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩はREADME.mdにかかっている，と言っても過言で...

1018 人がブックマーク・88 件のコメント

他のコメントを読む

＼コメントがサクサク読めるアプリです／

はてなブックマーク

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

はてなブックマーク

公式Twitter

はてなのサービス