kako-junです
好きな沢は 沢渡と金沢です
(だのに、これは野々市々の図書館で書いてるー)
Goでコマンドラインツールを 4つ並行して作ってたー
- cdand
- gohat
- gitp
- sex
3つがほぼできたんで 順番にpublicにしてるんだけど
README.mdが まだデフォルト(1行しかない状態)のまま
まず READMEについて調べたー
英語で書くのが常識らしい
README.mdとゆー名前のままにしとけば リポジトリのトップで出っぱなしになる
- README_ja.md
- README_en.md
とかじゃダメらしい
Electronで音楽プレーヤーを作った人 https://github.com/yui540/toa
の例(2年前)が興味深いわ
このケースでは README.mdが日本語で用意されてて
それを読めない人が 英語での説明も作ってよとリクエストしてきたそーな
このケースでは README.en.mdが作られ
内容はREADME.mdと そっくりのデザインのまま
日本語と1対1に対応するよーに翻訳されてる
README.mdの文中に README.en.mdへのリンクは無いけど
ファイル一覧を見れば 気づくワケで
バランスのイイ やり方やわ
3択やね
- README.mdを日本語で用意し、英語圏にはREADME_en.mdを用意する
- README.mdを英語で用意し、地元向けにREADME_ja.mdを用意する
- README.mdだけを用意し、すべての説明で日本語1文と英語1文を並べて書く
3が1番楽だけど やってる例を見たこと無い
縦長くなるからかな?
日本語ネイティブの母数が少ないからかな?
せっかくだから2の扉を選ぶぜ
でもそーすると
私は英語も日本語も完璧でないので
README.mdのコミット回数が やたら増えちゃうんよね
そこで Gistで下書きすればイイじゃん って思ったんよ
思考言語は日本語寄りなので まず日本語でGistを何回も書き直す
これも説明したほうがイイ! みたいなツッコミがあれば コメント欄に書いてもらえる (来ねーよ)
多いRevision数は Gistの華
とりあえず殺ってみよう