lightline.vimはVimのステータスラインをいい感じにしてくれるプラグインです。 作って四年弱経つんですね。 おかげさまで多くのユーザーさまに使っていただいています。
このREADME.mdを最近書き換えました。
………
それだけかいな！って感じなのですが、いろいろと大変でした… 主に精神的に… つらい…
- プラグインを作った勢いと使って欲しいという強い思いで、プラグインを作ってすぐにREADME.mdをかなり詳しく書いていた
- そのために当初の設計や実装時の思いが強く出ていたが、初めてプラグインを触る人にとっては読みにくい文章になってしまっていた
- パッチをあてたフォントを使わないとプラグインが使えないと誤解されることがあった。実際、スクリーンショットの多くがパッチをあてたフォントを使った状態で撮っていた。
- スクリーンショットの画質がかなり悪かった
とにかくいろいろと書き換えたいと思いつつ何か月も経ってしまったのですが、なかなか手が進みませんでした。 一応プラグインを作ってから三年以上、沢山の方にREADME.mdを読んでいただいていて、そこそこ機能していました。 そこそこ長い英語の文章で書いてしまったので、これをまた全体を書き直すのが億劫になっていたというのもあります。
いや、ほんと、一旦書いた英語の文章を、いい感じに書き直すの大変ですよ… しかもそれが趣味プロダクトのREADMEで、書き換えるのが必須でもなくて…
なんて思っていたのですが、やはりいろいろとよくないことも多かったので、最近一気に書き直しました。
- 関数コンポーネントを使うことで、短い設定でいろいろと見た目を変更できることを伝えるようにしました。
- パッチフォントに関する言及は辞めました。引き続き特殊なフォントのグリフを使うことはできますが、ポータビリティは悪いのであまりオススメはしません。
- 誤解を生みやすい
component_visible_conditionの説明はやめました。関数コンポーネントを使えば十分です。 - スクリーンショットをきれいに撮り直しました。
そんなこんなで少しは読みやすくなったかな〜と思います。
ヘルプの方も近いうちに書き換えていきます。 こんな感じです！ じゃあね！
