#イケてるReadmeの紹介
こんにちは。文系学生からITエンジニアに転生しようとしているグッピーです。今回はReadmeのかっちょいいテンプレや事例をご紹介していきます。ほとんど海外のテンプレなので、日本語ですぐに使えないのが難点ですが、気合いでなんとかしましょう!!
また、今回紹介するReadmeはこちらから選んだものとなります。紹介するもの以外にも色々あるので、訪れてみるのもいいかもしれないです。
参考:https://github.com/matiassingers/awesome-readme
##No.1 Fiber
最初に紹介するのはGo用に書かれたHTTPを高速化するフレームワークFiberのReadmeです。正直最初見たときに度肝を抜かれました。トップには各言語用のページに飛ぶためのボタンが設置されており、そのページに飛ぶとその言語で書かれたFiberのページが表示されます。
めちゃくちゃ親切じゃないですか・・・
エンジニア就職をしようと考えて色々勉強していますが、こういった色々な人に配慮している献身さをみると感動してしまいます。
紹介したReadme:https://github.com/gofiber/fiber/blob/master/.github/README.md
##No.2 Markdownify
次に紹介するのはMarkdownify。markdown記法を簡単に扱えるようになるエディターです。これでQittaの記事を書くのも高速化するかも??
紹介したReadme:https://github.com/amitmerchant1990/electron-markdownify#readme
##No.3 Color LS
次に紹介するのはRubyのColor lsスクリプトのまとめが載っているReadmeです。事例がとても見やすいです。
紹介したReadme:https://github.com/athityakumar/colorls#color-ls
##No.4 WELL
次に紹介するのはWELLというメンタルヘルスのアプリです。絵文字がたくさん使われていてとても見やすくなってます。
紹介したReadme:https://github.com/chroline/well_app#readme
##No.5 GitPoint
次に紹介するのはGitPointというスマホでGitHubのリポジトリなどが見れちゃうアプリのReadmeです。シンプルで見やすい構成になっています。
紹介したReadme:https://github.com/gitpoint/git-point#readme
##No.6 Human Activity Recognition
次に紹介するのはHuman Activity Recognitionというスマホなどを使って人の行動を分類する目的のプロジェクトです。Gifなどが使われていてデザイン性が高いReadmeとなっています。
紹介したReadme:https://github.com/ma-shamshiri/Human-Activity-Recognition#readme
##No.7 ngcolombia
次に紹介するのはngcolombiaという会社??のプロジェクトのReadmeです。名簿みたいになっていてとても面白いReadmeになっています。会社紹介などをReadmeでしたいときには最適?ですね。
紹介したReadme:https://github.com/ngcolombia/medellin#readme
##No.8 readme-md-generator
次に紹介するのはreadme-md-generatorです。簡単に綺麗なReadmeを作れるプロジェクトになっています。見た目自体もとてもシンプルで綺麗なものだったので紹介させていただきました。
紹介したReadme:https://github.com/kefranabg/readme-md-generator/blob/master/README.md
##最後に
いかがでしょうか??皆さんのお気に入りは見つかりましたでしょうか??色々とかっこいいReadmeに加えて、個性的なものまで紹介させていただきました。もし何か意見やご要望などがありましたらコメント欄の方までよろしくお願いします!!
以上グッピーでした!
##紹介したReadme
https://github.com/matiassingers/awesome-readme
https://github.com/gofiber/fiber/blob/master/.github/README.md
https://github.com/amitmerchant1990/electron-markdownify#readme
https://github.com/athityakumar/colorls#color-ls
https://github.com/chroline/well_app#readme
https://github.com/gitpoint/git-point#readme
https://github.com/ma-shamshiri/Human-Activity-Recognition#readme
https://github.com/ngcolombia/medellin#readme
https://github.com/kefranabg/readme-md-generator/blob/master/README.md