Skip to content

Fix typos on both README and align en to ja - #33

Merged
sago35 merged 24 commits into
mainfrom
feature/update-readme_EN
May 17, 2026
Merged

Fix typos on both README and align en to ja#33
sago35 merged 24 commits into
mainfrom
feature/update-readme_EN

Conversation

@ysaito8015

@ysaito8015 ysaito8015 commented May 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

This PR updates the English README (README_EN.md) to align with the Japanese version, and fixes typos in both versions.

Changes to English version

  • Fix typos: "hwo" → "how", "SetPizel" → "SetPixel", "throught" → "through", "writting" → "writing"
  • Update TinyGo version references: 0.35.0 → 0.40.1/0.39.0
  • Add missing sections:
    • Command-line Completion (Bash / Zsh / Clink)
    • Using a Buzzer (PWM configuration and example)
    • Using an I2C Temperature/Humidity Sensor (SHT4x)
    • koebiten (2D game engine for TinyGo)
  • Add missing references:
    • MIDI section: ./21_midi2, conejoninja/midikeeb
  • Fix broken image paths and code block types
  • Convert all ※ notes to Note: format for consistency
  • Improve phrasing throughout for natural English
  • Restructure document:
    • Promote Troubleshooting to top-level section
    • Promote Examples to top-level section
    • Organize Examples with MIDI/Buzzer categories

Changes to Japanese version

  • Fix typos:
    • Missing ) in OLED section
    • Double // in MIDI link
    • Double ) in buzzer image path
    • Wrong pin comments (EX01→EX03/EX04)
    • "keybord" → "keyboard"
    • Grammar: の→を

概要

英語版README(README_EN.md)を日本語版に合わせて更新し、両バージョンのタイポを修正しました。

英語版の変更

  • タイポ修正: "hwo" → "how", "SetPizel" → "SetPixel", "throught" → "through", "writting" → "writing"
  • TinyGoバージョン更新: 0.35.0 → 0.40.1/0.39.0
  • 不足セクションを追加:
    • コマンドライン補完 (Bash / Zsh / Clink)
    • buzzerを使う(PWM設定と例)
    • I2C接続の温湿度センサーを使う(SHT4x)
    • koebiten(TinyGo向け2Dゲームエンジン)
  • 不足リファレンスを追加:
    • MIDIセクション: ./21_midi2, conejoninja/midikeeb
  • 壊れた画像パスとコードブロックタイプを修正
  • 全ての※注記を*Note:*形式に統一
  • 自然な英語表現に改善
  • ドキュメント構造を再編成:
    • トラブルシュートをトップレベルセクションに昇格
    • 作例をトップレベルセクションに昇格
    • 作例をMIDI/Buzzerカテゴリで整理

日本語版の変更

  • タイポ修正:
    • OLEDセクションの) 欠落
    • MIDIリンクの//重複
    • buzzer画像パスの)重複
    • ピンコメントの誤り (EX01→EX03/EX04)
    • "keybord" → "keyboard"
    • 文法: の→を

@ysaito8015 ysaito8015 self-assigned this May 12, 2026
@ysaito8015 ysaito8015 added documentation Improvements or additions to documentation labels May 12, 2026
@ysaito8015
ysaito8015 marked this pull request as ready for review May 12, 2026 20:57
@ysaito8015
ysaito8015 requested a review from sago35 May 12, 2026 20:57

@sago35 sago35 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

ものすごく細かいところまでありがとう!

@sago35
sago35 merged commit e71dc8f into main May 17, 2026
1 check passed
@sago35
sago35 deleted the feature/update-readme_EN branch May 17, 2026 03:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants