ウニ’s blog

勉強した結果を書いていきます

GitHubにツールを公開する(1)

つらい。README.md書くのがすごくつらい。そんな1日だった。


ツールの基本動作部分は割りとあっさり出来た。
しかし、他人に使ってもらえるように細部の体裁に仕上げるぞ!
と、思ってからがものすごく時間かかってて、もうなんだか嫌になってきた・・・。
Pythonの楽しさ摩耗させながら延々と生産性無いことしてる気分だ。なんとかしたい。

冒頭のREADME.mdのHow to use説明文章もそうだけど、
ソースコードも変数名わかりやすくしたり、コメント入れたり、
例外処理やんなきゃとか、コマンドライン引数どうしようとか、
追加機能つけてえとかやってて、どうでもいいツールのくせに無限に終わらない。

完全に無駄頑張り感がでてきてる。
ある程度見切りつけてえいやで公開するしか無い、という結論になるまで時間がかかった。

やること
  • 細かいエラー制御はいらん。使う人がエラー内容見て判断する。
  • How to useの文言検討してるだけで日が暮れた。
    • 使い方は最小限しか書かない。あとは動画で見せる。See YouTube!
  • 独自のデータフォーマットの説明がほんとにうまく書けない。
    • どうすりゃいい!
    • See YouTube!

See YouTube!!(おわり)