2012年3月31日土曜日

githubでかっこいいREADMEを書く

githubにアップしたプロジェクトでは、READMEがトップに表示されるようになっており、これがきちんと書かれていると結構目を引く。
ただ、書き方がよくわからない!という場合は他の人をまねすればいい。

適当な、READMEがきちんとしているプロジェクトにアクセスしREADMEをクリックして参照する。ここで「RAW」と書かれているボタンをクリックすると生のファイルが閲覧できるので、どういうふうに書けばどう表示されるのかだいたい分かる。

あとは、このファイルを元に編集していけば良い。すばらしい方がオンライン上でプレビューできるツールを作ってくださっているので、そこにRAWで取得した内容をコピペして編集すればより精度は高まる。

githubプレビューツール

2 件のコメント:

  1. A very well-written post. I read and liked the post and have also bookmarked you. All the best for future endeavors
    IT Company India

    返信削除
  2. I’m seriously happy to discover this great site the future of this blog is getting good and more useful for me thanks and god bless you.
    IT Learning

    返信削除