Skip to content

docs: add Simplified Chinese README#677

Merged
jahooma merged 1 commit into
CodebuffAI:mainfrom
whtis:night-shift/20260514-readme-zh-cn
May 14, 2026
Merged

docs: add Simplified Chinese README#677
jahooma merged 1 commit into
CodebuffAI:mainfrom
whtis:night-shift/20260514-readme-zh-cn

Conversation

@whtis
Copy link
Copy Markdown
Contributor

@whtis whtis commented May 13, 2026

What

Add a Simplified Chinese translation of README.md as README.zh-CN.md, and a language switcher link at the top of both files.

Why

Codebuff has a growing audience among Chinese-speaking developers (the project ships with Qwen and DeepSeek as first-class model choices), but the entry point — the README — is English-only today. A native zh-CN README makes the project's positioning, multi-agent design, and SDK/CLI surface area much more accessible to that audience, with zero impact on existing readers.

Scope

  • New file: README.zh-CN.md — a hand-written translation that preserves the original structure, headings, code blocks, links, and tone. Brand names (Codebuff, Freebuff, OpenRouter, etc.) and code samples are intentionally kept in their original form; only natural-language prose is translated.
  • README.md: a single English | [简体中文](./README.zh-CN.md) line added below the title, matching the convention used by many bilingual READMEs on GitHub.

No code, build, or CI changes.

How tested

  • Rendered both READMEs locally (markdown preview) — headings, code fences, images, and links all resolve correctly.
  • Verified ./README.zh-CN.md link from the English README and ./README.md link back from the Chinese README both work.
  • Diff is contained to two files (one new, one two-line edit); no other surfaces touched.

Happy to adjust phrasing, file naming (README_zh-CN.md vs README.zh-CN.md), or split the language switcher into a separate change if that fits the project better.

Drafted with AI assistance; verified by author before publishing.

@whtis whtis marked this pull request as ready for review May 14, 2026 03:08
@jahooma
Copy link
Copy Markdown
Contributor

jahooma commented May 14, 2026

Oh wow, that's awesome! ChatGPT said it's a faithful translation. I'll merge it now, thanks!

@jahooma jahooma merged commit 37d0892 into CodebuffAI:main May 14, 2026
@whtis
Copy link
Copy Markdown
Contributor Author

whtis commented May 14, 2026

Thanks so much for the quick merge — really happy to be contributing to this project! 🙌

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