この Readme がすごい! 2014

  • このエントリーをはてなブックマークに追加

      2020/08/31

みなさん、GitHub は使っていますか?

ソーシャルコーディングという言葉が一昔前に流行りましたが、今や OSS の大半は GitHub 上でソースを管理していると言っても過言ではありません。

逆に言うと、 GitHub には数多くのプロジェクトが存在していて、私達は情報の取捨選択を強いられています。

辛いですね。

ところで、最近 peco というツールが流行っていますが、その作者である @lestrrat さんが自信のプロジェクトの成功の一端に Readme の作り込みを挙げています。

pecoがぼちぼち成功した3つの理由 : D–7

確かに、興味をもったプロジェクトを全て手元で実行してみるのは大変なので、そのプロジェクトが何を解決するものなのかが Readme でわかるとぐっと敷居が下がりますね。

また、Readme が個性的なプロジェクトはそれだけで話題にもなります。

ということで、今回は GitHub 上の様々なプロジェクトから、これはすごいと思った Readme をいくつか取り上げてみます。

CLI デモ

ツールの使用例を GIF アニメで載せているプロジェクトを集めました。ライブコーディングを見ているような感覚になりますね。

peco/peco

https://github.com/peco/peco

peco

豊富なデモアニメで便利さがすごく伝わるので、思わず使いたくなってしまいます。デモ以外の項目についてもとても丁寧に記述されています。

mooz/percol

https://github.com/mooz/percol

percol

peco の基になった percol もデモアニメが設置されています。

dinedal/textql

https://github.com/dinedal/textql

textql

アニメーションの速度がちょうどいい感じでわかりやすい。

Vim プラグインデモ

自分が Vim を使うので、 Vim プラグイン特集です。
Vim 界隈では GIF のデモへの活用が普及してきているようですが、Emacs の方ではどうなんですかね?

terryma/vim-multiple-cursors

https://github.com/terryma/vim-multiple-cursors

vim-multiple-cursors

短いデモのテンポの良さとフォントサイズが好きです。

junegunn/vim-plug

https://github.com/junegunn/vim-plug

Vim プラグインの管理は NeoBundle 等競合が色々有りますが、見た目のかっこよさは大事なんだと教えてくれる作品です。

Lokaltog/vim-easymotion

https://github.com/Lokaltog/vim-easymotion

vim-easymotion

キー入力が画面に表示されるのが非常に親切です。このデモ、何で作ってるんですかね?

Shougo/unite.vim

https://github.com/Shougo/unite.vim

暗黒美夢王として有名な @ShougoMatsu さんも GIF デモ活用をしています。

GUI デモ

同じように UI フレームワークの実際の挙動や、GUI ツールの使い勝手をアニメーションで指名してくれているプロジェクトを集めました。

Flipboard/FLEX

https://github.com/Flipboard/FLEX

Flipboard の提供する iOS 向けデバッグツールは、その謎の技術を存分に見せつけてくれます。

ricardoalcocer/alloy-widget-drawermenu

https://github.com/ricardoalcocer/alloy-widget-drawermenu

alloy-widget-drawermenu

JavaScript の UI フレームワークならともかく、ネイティブアプリのデモは気軽に用意できないので、GIF アニメ化するのが良さそうですね。

maurizzzio/PojoViz

https://github.com/maurizzzio/PojoViz

PojoViz

JavaScript ライブラリのオブジェクトの相関関係が見れるツール。ちなみにデモはこちら Pojo Viz

muan/emoji

https://github.com/muan/emoji

emoji

最初にチラッと見える Chrome の New Tab ページ(かな?)が可愛い。

muan/megamoji

https://github.com/muan/megamoji

muan/megamoji

なんかよくわからないけどすごい!

プロジェクト名の由来

アイキャッチはその名の通り、ユーザの目を引くために置かれる画像です。プロジェクトに由来する画像を貼ることで、印象深くなります。

tsenart/vegeta

https://github.com/tsenart/vegeta

tsenart/vegeta

皆さんおなじみ、某惑星の王子です。しかしなぜ……?

jlund/streisand

https://github.com/jlund/streisand

jlund/streisand

ストライサンド効果 、消すと増えるあれです。

mattn/anko

https://github.com/mattn/anko

mattn/anko

美味しそう。

一目瞭然

auduno/clmtrackr

https://github.com/auduno/clmtrackr

auduno/clmtrackr

一瞬で何のためのツールか把握できます。JavaScript ライブラリだというのが驚き。

Kawaii

Readme が可愛いと少しのバグ位なら許せちゃいますよね(要調査)。
ここからは画像の引用無しなので直接見に行ってください。

cupakromer/emoji-rspec

GitHub の Readme や Issues, Pull request には絵文字を表示する機能もあるのです :+1:

leereilly/emoji

コミットコメントにも絵文字を使えます。(Readme 関係ない)

naoya/hubot-sushiyuki

寿司エンジニア御用達の寿司ゆきも。

photonstorm/phaser

区切りの代わりに、遊び心が感じられる謎キャラ登場です。

AA

みんな大好き アスキーアート!プロジェクトの関係性が薄いものも……。

jgs は Joan Stark です。

defunkt/jquery-pjax

scrooloose/syntastic

番外編1 狂気

プロダクトのヤバさをひと目で伝えるとびきりの Readme を集めました。

kawasima/jagrid

https://github.com/kawasima/jagrid

みんな大好きエクセル方眼紙の CSSフレームワーク!?

TooTallNate/ansi-canvas

https://github.com/TooTallNate/ansi-canvas


Render a <canvas> node to your terminal

bash とか書いてるのウケます。

itchyny/calendar.vim

https://github.com/itchyny/calendar.vim

Calendar on Vim です。Vim への愛が感じられる逸品です。

番外編2 恐怖

※心臓の悪い人は注意

glidenote/learning-tmux

Gist でやれ

まとめ

さて、いかがでしたでしょうか。

見た目の派手さにフォーカスし過ぎましたが、何かの参考になれば幸いです。

エンジョイ!

 -プログラミング

FAworksではプロのコンサルタントが案件をお探しします

  関連記事

React/Fluxにおける問題とReducerが切り開く道

私がReact/Fluxアプリケーションを書いてきて、もう1年になる。Flux開発の1年を振り返って

MySQL Cluster―MySQLはいかに2億QPSのスケーリングを実現したか

この記事は、オラクル社MySQL主任プロダクトマネージャ、アンドリュー・モルガン氏からのゲスト投稿で

良いプログラマの条件とは?

良いプログラマの条件とは?

野球の打者は、少なくとも30%の確率でヒットを打つことに成功すれば良いとされている。ゴルファーなら、

生まれてから100種以上に騎乗してきた僕が選ぶ本命ワーキングチェア。

どーも!こんにちは! 最近よく目にする「iPadのCM」の最後に出てくる都市、ベトナムはホーチミンで

【2020年版】東京周辺で開催のエンジニア向け技術系カンファレンス日程まとめ【全64件!】

重要:新型コロナウイルス感染症の拡大により、多数のイベントが中止または延期を発表しています。 公式サ

基本的なシステム性能とOSジッタを計測するためのツールキット

Linux サーバの基本的なシステム性能とOSジッタを計測するためのツールキット

Jean Dagenaisは、mechanical-sympathyのスレッドで、Gil Teneの

Appknoxアーキテクチャ – AWSからGoogle Cloudへの切り替え

Appknoxアーキテクチャ – AWSからGoogle Cloudへの切り替え

この記事はAppknox社のフルスタック&DevOpsエンジニアであるdhilipsiva氏による寄

CSSで縦書きに挑戦!writing-modeを使ってみた

「CSS Writing Modes Level 3」がW3Cの勧告に至ったことで、CSSの縦書きが

今、なぜフルスタックエンジニアになる必要が?

by Jim Pennucci 既にバズワードにもなりつつありますが、今、まさに現在進行中で、フルス

エンジニア向け!!新しいプログラミング言語を学ぶ時のサイト一覧

エンジニア向け!!新しいプログラミング言語を学ぶ時のサイト一覧

最近ではプログラミングスキルが世界で注目されており、就職や転職においても十分なスキルの一つとなってい