S-JIS[2011-12-29] 変更履歴
GitHubのREADMEファイルのメモ。
|
GitHubでは、READMEという名前のファイルを置いておくと、そのディレクトリーをブラウザーで表示したときにREADMEファイルの中身が表示される。
つまりそのディレクトリーの説明文をREADMEファイルに書いておくことが出来る。
READMEファイルは、拡張子によって表示のされ方が異なる。
例えば拡張子をwikiやmediawikiにしておくと、READMEの中身はmediawiki形式として解釈される。
どのようなファイル形式が使えるかはGitHub Markupを見れば分かるが、具体的にどのような拡張子が使えるのかはソース（markups.rb）を見ないと分からない模様。
READMEを書いてはコミット・pushしてブラウザーで確認する…というのは大変なので、プレビューを使って確認するのが良さそう。
→kei-sさんのGithub Preview