タグ

OSSとdevelopmentに関するsousousore1のブックマーク (2)

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

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

  • wri.peのソースコードを公開しました。

    schooで授業もやるし、まぁ隠しておく意味もないかなーと思ってので、wri.peのソースを公開する事にしました。 https://github.com/masuidrive/open-wripe 全部公開しているので、キーを適切にセットすれば自分で動かす事ができます。 元々、公開するつもりでは無かったので、ソースは読みやすくはなっていません(汗 pull-requestを貰えれば取り込みなども行いますので、興味のある方は直接投げてもらうか、Twitter/Facebookなどで声をかけてください。 4/1からwri.peの作り方を解説する授業を4週間schooで行いますので、興味のある方は聞いて頂けるとうれしいです。 増井雄一郎の「wri.pe」を事例に学ぶ、自作サービスの作り方〜サービスデザイン編 増井 雄一郎 先生 – 無料動画学習|schoo(スクー) Webサービスのつくり方

    wri.peのソースコードを公開しました。
  • 1