GithubのREADME.mdの書き方がわかるリンク先まとめ

2015/02/11 Web制作関係  このエントリーをはてなブックマークに追加
Githubと向き合うことにしたのはいいんですが、よくよく考えれば、皆様が準備してくださったファイルをダウンロードして変更したことがあるだけで、最初から自分で作ったことなかったです。これは早くも挫折の予感。


み「ということで、作り方が知りたい」

こ「とりあえずググって、readmeを作ってみたらいいんじゃない?」

み「なるほど!(いつもの感じでテスト用readme.txtを作る)

………


なんかREADME.mdってファイルが自動的に生まれたんですけど何これ。

そもそもREADME.mdって何?

と思ったんですが、Github使っている人は日常的にこのファイルを見ているはず(らしい)……どれだと思ったらGithubのページにある1番最初にファイルリストの下に表示されているやつ(例:リンク先)、これがREADME.mdの中身のようだ。例のサイトのように日本語も使える。

こうなると、ここはしっかり考えて書かないといけない。
適当に「テストだにょろよ〜」と書いておくだけではだめである。
あと、readme.txtの必要性が3秒で霧散した。
README.mdの書式に沿って書きなおさなければ(中身は1行だったけど)

以下、私が「改行できない!改行コードが違うのか!(関係無いです。書き方の問題です)」とか言いながら右往左往した際に役だったサイトをまとめます。初心者の方は一緒に書き方を覚えましょう。最初のページの解説って大切ですからね。


超参考になるありがたいサイト様

▼README.mdファイル。マークダウン記法まとめ
http://codechord.com/2012/01/readme-markdown/
 ※改行できなくて右往左往した時に助けてくれた神

▼GitHub - マークダウン記法でREADMEの可読性を高めよう
http://blog.takahash.com/entry/20120412/p1
 ※ここでようやく「#」が見出しだったことを知る。コメントアウトかと…

▼Alice-Gits/Hello-World
https://github.com/Alice-Gits/Hello-World
 ※と思ったら、ちゃんとまとめてくれている神がいた。このページを皆読むべき。


むしろ最後のファイルを標準でくっつけてくれたらいいのにと一瞬真剣に考えてしまいました。とりあえず改行と見出しの付け方を覚えたので、ちょっとずつやっていきます。
まだ肝心のJSファイルをアップロードしてないですけどね!

コメント

*
*

<< CKEditorでCSS・styleタグが書けるように設定する | phpMyAdminで「SELECT command denied to user〜」のエラー >>