docs: add Chinese translation for README#116
docs: add Chinese translation for README#116JasonYeYuhe wants to merge 1 commit intoKittenML:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a Chinese README to make project documentation accessible to Chinese-speaking developers, and updates the main README to link between languages.
Changes:
- Added
README.zh.mdwith a Chinese translation of the project README content. - Added an English/Chinese language switcher line near the top of
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.zh.md | New Chinese README translation, including usage/API docs and community links. |
| README.md | Adds a language switcher linking to README.zh.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### `model.generate_to_file(text, output_path, voice, speed, sample_rate, clean_text)` | ||
|
|
||
| 合成语音并直接写入音频文件。 | ||
|
|
||
| | 参数 | 类型 | 默认值 | 描述 | | ||
| |---|---|---|---| | ||
| | `text` | `str` | -- | 待合成的输入文本 | | ||
| | `output_path` | `str` | -- | 音频文件保存路径 | | ||
| | `voice` | `str` | `"expr-voice-5-m"` | 音色名称 | | ||
| | `speed` | `float` | `1.0` | 语速倍率 | | ||
| | `sample_rate` | `int` | `24000` | 音频采样率 (Hz) | | ||
| | `clean_text` | `bool` | `True` | 是否预处理文本 | |
There was a problem hiding this comment.
model.generate_to_file(...) 的文档签名和参数表里包含了 clean_text 参数，但当前 Python API（kittentts/get_model.py 的 KittenTTS.generate_to_file）并不接受该参数；这会导致读者按文档调用时报 TypeError。建议要么在 README 中移除/标注该参数，要么在 API 中补齐并透传到内部实现。
|
|
||
| ## 社区与支持 | ||
|
|
||
| - **Discord:** [加入社区](https://discord.gg/VJ86W4SURW) |
There was a problem hiding this comment.
同一份文档里 Discord 邀请链接使用了两种不同格式（上方 badge 是 discord.com/invite/...，这里是 discord.gg/...）。为避免其中一个失效或造成困惑，建议统一为与 README.md / 顶部 badge 相同的链接。
| - **Discord:** [加入社区](https://discord.gg/VJ86W4SURW) | |
| - **Discord:** [加入社区](https://discord.com/invite/VJ86W4SURW) |
|
|
||
| - **Discord:** [加入社区](https://discord.gg/VJ86W4SURW) | ||
| - **官网:** [kittenml.com](https://kittenml.com) | ||
| - **定制支持:** [申请表单单](https://docs.google.com/forms/d/e/1FAIpQLSc49erSr7jmh3H2yeqH4oZyRRuXm0ROuQdOgWguTzx6SMdUnQ/viewform?usp=preview) |
There was a problem hiding this comment.
这里的链接文案有重复字：申请表单单。建议更正为 申请表单。
| - **定制支持:** [申请表单单](https://docs.google.com/forms/d/e/1FAIpQLSc49erSr7jmh3H2yeqH4oZyRRuXm0ROuQdOgWguTzx6SMdUnQ/viewform?usp=preview) | |
| - **定制支持:** [申请表单](https://docs.google.com/forms/d/e/1FAIpQLSc49erSr7jmh3H2yeqH4oZyRRuXm0ROuQdOgWguTzx6SMdUnQ/viewform?usp=preview) |
docs: add Chinese translation for README
Description
This PR introduces a high-quality Chinese translation of the README (
README.zh.md) and adds a language switcher to the mainREADME.md.Motivation
Kitten TTS is an impressive lightweight TTS library. Given the rapid growth of edge AI and mobile development in the Chinese developer community, providing localized documentation will help more users integrate this CPU-optimized synthesis engine into their IoT, mobile, and desktop applications.
This translation covers:
Changes
README.zh.mdwith localized terminology.Translated and contributed by @JasonYeYuhe