Skip to content

Add multilingual README documentation - #2

Merged
WJiangzhi merged 1 commit into
masterfrom
codex/readme.md
Sep 18, 2026
Merged

WJiangzhi merged 1 commit into
masterfrom
codex/readme.md

Conversation

@WJiangzhi

Copy link
Copy Markdown
Member

Motivation

  • Provide comprehensive project documentation in English, Simplified Chinese, and Traditional Chinese so users can read build instructions, CLI usage, library examples, and licensing in their preferred language.
  • Include cross-links between language variants and a link to the LICENSE so readers can easily navigate and confirm project terms.

Description

  • Add README.md, README.zh-CN.md, and README.zh-TW.md containing build instructions, CLI examples, options table, library usage examples, and license information.
  • Include command examples for building with cmake and invoking the CLI (zbtca-cli), plus a short C++ snippet demonstrating ZBTCA_Bin + ZBTCA_Output usage.
  • Add language navigation links between the three READMEs and link to the LICENSE file from each README.

Testing

  • Ran git diff --check which reported no whitespace or diff-check issues and completed successfully.
  • Executed a Python validation script that confirmed each README contains links to the other language files and to LICENSE, and the check passed.
  • Ran cmake -S . -B build which failed in this environment because the installed CMake is 3.28.3 while the project requires 3.31.6, so configuration could not complete.

Codex Task

@WJiangzhi
WJiangzhi merged commit 7c4b6c6 into master Sep 18, 2026
8 checks passed
@WJiangzhi
WJiangzhi deleted the codex/readme.md branch September 26, 2026 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant