Skip to content

docs: add Simplified Chinese translation (README.zh.md) - #1553

Open
JasonYeYuhe wants to merge 1 commit into
google:mainfrom
jasonye-oss:docs/add-zh-readme
Open

JasonYeYuhe wants to merge 1 commit into
google:mainfrom
jasonye-oss:docs/add-zh-readme

Conversation

@JasonYeYuhe

Copy link
Copy Markdown

Description

This PR introduces the Simplified Chinese translation of the root README.md (README.zh.md) for google/zx, helping Chinese-speaking developers, Node.js engineers, and system administrators understand zx features, installation options, runtime compatibility (Node.js, Bun, Deno, GraalVM, Electron), and CLI scripting patterns.

Summary of Changes:

  • README.zh.md: Faithful 1:1 translation of the repository overview, including:
    • Overview of zx and its advantages over raw Bash / standard child_process
    • JavaScript example demonstrating async subshells, pipe handling, parallel execution, and variable interpolation
    • Installation instructions (npm install zx) and setup links (zx/setup, zx@lite)
    • Documentation and code examples links
    • Compatibility matrix across OS platforms, JS runtimes, shells (Bash, PowerShell), and module systems (CJS, ESM, JS, TS)
    • Single-source-of-truth disclaimer directing to the canonical English documentation
  • README.md: Added bidirectional language switcher navigation link [ English | [简体中文](https://github.com/google/zx/blob/main/README.zh.md) ].

Verification:

  • Formatted with Prettier 3.9 (npm run fmt:check compliant).
  • Passes Conventional Commits (commitlint).
  • Clean formatting with zero trailing whitespace.

Signed-off-by: YE <yyyyy.yeyuhe@gmail.com>

This branch has not been deployed

No deployments
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.

1 participant