docs: README と license を置く

[torabit]

変更内容

• README.md を英語で置いた。実機の画面を載せている
• LICENSE に MIT を置き、Cargo.toml に license と description と repository を足した
• examples/demo.rs を足した。合成した入力で画面だけを見る
• 見出しの .small() を外した

なぜ

README

公開するので要る。英語にしたのは、画面に日本語を出さない判断と揃えるため。日本語のフォントが入っていない Windows があるので画面を英語にしたが、README だけ日本語だと、画面を見た人が読める文書が無くなる。

F 数がゲームのフレーム数と一致しない件を独立した節にした。位相が観測できないこと、だから小数で出していることを書いている。この道具を使う人が最初に誤解する場所になる。

license

license が無い public repository は全権利留保の扱いになり、受け取った人が使ってよいかを判断できない。MIT にした。制約が最も少ない。

demo

デバイスも Windows も無しに表示を見られる。表示を直すたびに build して渡して写真を待つと、1 往復が数十分になる。

配るものには入らない。examples/ は cargo build --release の成果物に含まれず、.coupling.toml の解析対象 (./src) にも入らない。

見出しのずれ

header_text が .small() を付けていた。等幅でも字送りが本文と変わるので、同じ文字位置が違うピクセル位置になる。1 行を等幅で組んで桁を揃えた意味が、見出しの行だけ消えていた。

実機の画面で見つけた。.weak() は残すので、見出しは薄いままになる。

実機で確かめたもの

Windows と DualSense を持つ人に v0.1.1 を渡して確認した。

確かめたこと	結果
画面の文字が読める	読める
同時押しの行で F の列がずれない	ずれない
離した区間の行が出ない	出ない
console の窓が開かない	開かない
frametap-panic.txt ができない	できない
ウィンドウを完全に覆っても記録が続く	続く
fps = 30 で F が倍になる	倍になる

ウィンドウを覆っても記録が続くことは、設計 spec の未検証の前提にあった。これで潰れた。

載せた画像は v0.1.1 のものなので、先頭行に版が出ていない。v0.1.2 で出るようになった。

検証

• cargo fmt --check
• cargo clippy --all-targets -- -D warnings
• cargo test (109 件)
• cargo coupling --check --min-grade=B --max-circular=0 ./src は Grade A (30%)

見出しのずれは Windows で見ないと直ったことを確かめられない。次に渡すときの確認事項になる。