somemo's diary

プログラマ、雑記、プログラミング関係はLinkから、数式はこっちでまとめていることが多い

【git】READMEの拡張子別書式とファイル名変更【github】

今日からテスト駆動開発入門の写経を始めます。

そのためgithubにリポジトリを作成し、環境等をREADMEにまとめました。

https://github.com/ksomemo/tdd_ex

今日のメモは、TDDの前にgithubでのREADMEについてです。 RAEDMEは拡張子によって、表示が変更されるようです。 各表示については、https://github.com/github/markup参照 今回の表示形式は、redmineでも使われている「textile」にしました。

textileについては、http://redmine.jp/tech_note/textile/参照

そもそも、なぜ必要になったのか?

githubにて、TDD入門のToDoリストをREADMEで実現しているリポジトリに遭遇したので真似するためです。 githubのREADMEファイルは、何も行わなくとも中身が表示されるので、現状を把握するために便利だと思います。

遭遇したリポジトリからダウンロードしたファイルを参考にREADMEをtextileにし、 githubに「git pull」しましたが、拡張子が無かったので、「git mv src dst」をすることで、ようやく実現できました。 上記のリネームにより、TortoiseGitおよびgithubの履歴ログでもリネームを確認できます。

ちなみに今回使用した記法は、以下のとおりです。 * 表示文言 * -取り消し文言- 上記が、下のように変換されます。

  • 表示文言
  • 表示文言

以上