Sync README: add English README, rewrite Chinese README#12
Conversation
…(zh-cn).md Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSMScript-Lite/sessions/dcd4976b-e500-4f63-a613-757a664c7338 Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR synchronizes the repository documentation by making README.md an English README and adding a restructured Chinese README that mirrors the English layout, improving accessibility and consistency for bilingual users.
Changes:
- Converted
README.mdfrom Chinese to English with a language switcher, badge, streamlined intro, and reorganized feature/dependency sections. - Added
README(zh-cn).mdwith the same structure and rewritten, more concise Chinese prose.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Rewritten in English; reorganizes overview, dependencies, and feature documentation. |
| README(zh-cn).md | New Chinese README matching the English structure and sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **CSMScript-Lite Library** — A lightweight CSM script execution engine, itself implemented as a CSM module. | ||
| - **Engine**: Core execution engine that parses and runs CSM scripts, managing test state and results. | ||
| - **UI**: User interface for script management, execution control, and result viewing. | ||
| - **App**: A sample application demonstrating how to use the CSMScript library. |
There was a problem hiding this comment.
In the component list, "App" is described as demonstrating how to use the "CSMScript" library, but elsewhere the README refers to "CSMScript-Lite Library". This inconsistent naming is likely to confuse users; consider using one consistent library name (e.g., "CSMScript-Lite" / "CSMScript-Engine(Lite)") throughout the README.
| - **App**: A sample application demonstrating how to use the CSMScript library. | |
| - **App**: A sample application demonstrating how to use the CSMScript-Lite Library. |
| ### Extended Commands | ||
|
|
||
| 格式与 CSM 指令类似：`指令 >> 参数`，指令名称大小写不敏感。 | ||
| CSMScript provides built-in commands beyond the standard CSM command set. The syntax follows the same pattern as CSM: `command >> arguments`. Command names are case-insensitive. |
There was a problem hiding this comment.
The "Extended Commands" section says "CSMScript provides built-in commands..." while the repository/project is presented as CSMScript-Lite. Align the product name here with the rest of the README to avoid ambiguity about which component provides these commands.
| CSMScript provides built-in commands beyond the standard CSM command set. The syntax follows the same pattern as CSM: `command >> arguments`. Command names are case-insensitive. | |
| CSMScript-Lite provides built-in commands beyond the standard CSM command set. The syntax follows the same pattern as CSM: `command >> arguments`. Command names are case-insensitive. |
| - **CSMScript-Lite Library** — 轻量级 CSM 脚本执行引擎，其本身也是一个基于 CSM 实现的模块。 | ||
| - **Engine**：核心执行引擎，负责解析并运行 CSM 脚本，管理测试状态与结果。 | ||
| - **UI**：用户界面，提供脚本管理、执行控制和结果查看功能。 | ||
| - **App**：示例应用程序，展示如何使用 CSMScript 库执行脚本。 |
There was a problem hiding this comment.
“App”条目中写的是“展示如何使用 CSMScript 库执行脚本”，但文档其它位置使用的是“CSMScript-Lite Library/CSMScript-Lite”。建议统一库/产品名称（例如统一为 CSMScript-Lite 或 CSMScript-Engine(Lite)），避免读者误以为是另一个项目。
| - **App**：示例应用程序，展示如何使用 CSMScript 库执行脚本。 | |
| - **App**：示例应用程序，展示如何使用 CSMScript-Lite Library 执行脚本。 |
|
|
||
| ### 扩充指令 | ||
|
|
||
| CSMScript 内置了一套超出标准 CSM 命令集的扩充指令，语法与 CSM 指令相同：`指令 >> 参数`，指令名称大小写不敏感。 |
There was a problem hiding this comment.
“扩充指令”段落以“CSMScript 内置...”开头，但当前仓库/文档标题是 CSMScript-Lite。建议这里也使用一致的名称，明确到底是 CSMScript-Lite（或其 Engine 模块）提供这些扩展指令。
| CSMScript 内置了一套超出标准 CSM 命令集的扩充指令，语法与 CSM 指令相同：`指令 >> 参数`，指令名称大小写不敏感。 | |
| CSMScript-Lite 引擎模块内置了一套超出标准 CSM 命令集的扩充指令，语法与 CSM 指令相同：`指令 >> 参数`，指令名称大小写不敏感。 |
* Add new resource files for Utility and global resource strings - Created Utility.mnu to define menu resources for the Utility module. - Added global-rc-strings.vi to manage localized strings for the CSM Script Engine (Lite). * update build spec & version * docs: 更新README中的图片引用路径 修正README.md中图片引用路径的大小写问题，保持与实际文件名一致 * Sync and rewrite README: add English README.md, create Chinese README(zh-cn).md (#12) Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSMScript-Lite/sessions/dcd4976b-e500-4f63-a613-757a664c7338 Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> * trigger workflow * fix https://github.com/NEVSTOP-LAB/CSMScript-Lite/actions/runs/23787987199/job/69315880268 --------- Co-authored-by: yao0928 <yao.li@emerson.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: nevstop <nevstop@NEVSTOP-LAB>
The repo only had a Chinese README with no English counterpart, and the Chinese prose was verbose and inconsistent in structure.
Changes
README.md— Converted to English, following the same style as Communicable-State-Machine: language switcher, GitHub releases badge, concise intro, hyperlinked dependencies, and clean feature sections.README(zh-cn).md— New Chinese README mirroring the English structure exactly; prose rewritten to be more natural and concise.Structure (both files)
[English] | [中文]at top