ブックマーク / at-aka.blogspot.com (1)

  • Github の README ファイルを wiki 書式で書く

    githubプロジェクトを登録したら、README ファイルを用意しておくと良い。すると、github はそのプロジェクトのトップページに、その「README」ファイルの中身を表示する。初めてそのプロジェクト・ページにアクセスした人は、README ファイルを開かずに概要を知ることができる。プロジェクトを公開する側も、使おうと考えている側にとってもメリットは大きい。 一般に README ファイルはテキスト・ファイルで用意してやれば良い。 しかし、中には README ファイルも HTML の様に「綺麗」に表示されることを望む人も居ることと思う。URL があれば、それがリンクになることを望むことと思う。ヘッダーは大きな文字で表示される方が嬉しかろう。 そんな人のために、github は wiki の書式を README に入れる仕組みを用意している。 README に wiki 書式を

    proxy0721
    proxy0721 2012/01/14
  • 1