Skip to content

README: add bilingual README (EN/ZH) for all demo projects#69

Open
TangMeng12 wants to merge 1 commit intoopen-vela:devfrom
TangMeng12:docs/add-bilingual-readmes
Open

README: add bilingual README (EN/ZH) for all demo projects#69
TangMeng12 wants to merge 1 commit intoopen-vela:devfrom
TangMeng12:docs/add-bilingual-readmes

Conversation

@TangMeng12
Copy link
Contributor

  • Add standardized README.md (English) and README_zh-cn.md (Chinese) for all demo projects
  • Rename inconsistent Readme.md/Readme_zh-cn.md to standard README.md/README_zh-cn.md
  • Add language switch links at the top of each README
  • Update top-level README.md and README_zh-cn.md index with links to all projects
  • Remove deprecated music_player2/README-en.md (content moved to README.md)
  • Generate bilingual READMEs based on original content where available

Affected projects: bandx, breakout, calculator, hourglass, music_player, music_player2, pet, relation_calculator, snake_game, utils, x_track

Note: Please adhere to Contributing Guidelines.

Summary

Update this section with information on why change is necessary,
what it exactly does and how, if new feature shows up, provide
references (dependencies, similar problems and solutions), etc.

Impact

Update this section, where applicable, on how change affects users,
build process, hardware, documentation, security, compatibility, etc.

Testing

Update this section with details on how did you verify the change,
what Host was used for build (OS, CPU, compiler, ..), what Target was
used for verification (arch, board:config, ..), etc. Providing build
and runtime logs from before and after change is highly appreciated.

- Add standardized README.md (English) and README_zh-cn.md (Chinese) for all demo projects
- Rename inconsistent Readme.md/Readme_zh-cn.md to standard README.md/README_zh-cn.md
- Add language switch links at the top of each README
- Update top-level README.md and README_zh-cn.md index with links to all projects
- Remove deprecated music_player2/README-en.md (content moved to README.md)
- Generate bilingual READMEs based on original content where available

Affected projects: bandx, breakout, calculator, hourglass, music_player,
music_player2, pet, relation_calculator, snake_game, utils, x_track

Signed-off-by: v-tangmeng <v-tangmeng@xiaomi.com>
@TangMeng12 TangMeng12 force-pushed the docs/add-bilingual-readmes branch from 96c56dd to f3e679a Compare March 5, 2026 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants