Skip to content

Commit 9aaf802

Browse files
committed
docs: switch to English-default README with bilingual support
- README.md is now English (default) - README.zh-CN.md is Chinese - Standardized language switcher links in both files
1 parent 52da99c commit 9aaf802

8 files changed

Lines changed: 10 additions & 10 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
- "docs/**"
88
- "examples/*/README.md"
99
- "README.md"
10-
- "README.zh.md"
10+
- "README.zh-CN.md"
1111
- "SUMMARY.md"
1212
- "CONTRIBUTING.md"
1313
- "CONTRIBUTING.zh.md"

.kiro/specs/hpc-optimization-guide/design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ hpc-optimization-guide/
100100
├── CMakeLists.txt # 根 CMake 配置
101101
├── CMakePresets.json # 构建预设(debug/release/relwithdebinfo/asan/tsan/ubsan/coverage)
102102
├── README.md # 项目主文档(English)
103-
├── README.zh.md # 项目主文档(中文)
103+
├── README.zh-CN.md # 项目主文档(中文)
104104
├── CLAUDE.md # AI 助手上下文文档
105105
├── LICENSE
106106
@@ -465,7 +465,7 @@ enum class DifficultyLevel {
465465

466466
## Documentation Strategy
467467

468-
- 主 README 提供快速开始与模块索引,分为 `README.md`(English)和 `README.zh.md`(中文)。
468+
- 主 README 提供快速开始与模块索引,分为 `README.md`(English)和 `README.zh-CN.md`(中文)。
469469
- `docs/zh/learning-path.md` 和 `docs/en/learning-path.md` 作为推荐学习路线的唯一来源。
470470
- `docs/zh/profiling-guide.md` 和 `docs/en/profiling-guide.md` 覆盖常用性能分析工具的最小集合。
471471
- 模块 README 包含:背景、优化原理、运行命令、关键结果与常见误区。

.kiro/specs/hpc-optimization-guide/tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@
308308

309309
- [x] 15. 实现多语言文档支持
310310
- [x] 15.1 创建中文主 README
311-
- 创建 README.zh.md,与 README.md 内容对应
311+
- 创建 README.zh-CN.md,与 README.md 内容对应
312312
- _Requirements: 9.1_
313313

314314
- [x] 15.2 创建双语学习路径文档

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# C++ High Performance Computing Optimization Guide
22

3-
[中文版本](README.zh.md) | [GitBook Sync Guide](docs/en/gitbook-sync.md)
3+
English | [简体中文](README.zh-CN.md) | [GitBook Sync Guide](docs/en/gitbook-sync.md)
44

55
[![Build](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/build.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white&label=Build)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/build.yml)
66
[![Benchmarks](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/benchmark.yml?branch=main&style=for-the-badge&logo=speedtest&logoColor=white&label=Benchmarks)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/benchmark.yml)

README.zh.md renamed to README.zh-CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# C++ 高性能计算优化指南
22

3-
[English Version](README.md) | [GitBook 接入指南](docs/zh/gitbook-sync.md)
3+
[English](README.md) | 简体中文 | [GitBook 接入指南](docs/zh/gitbook-sync.md)
44

55
[![Build](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/build.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white&label=Build)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/build.yml)
66
[![Benchmarks](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/benchmark.yml?branch=main&style=for-the-badge&logo=speedtest&logoColor=white&label=Benchmarks)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/benchmark.yml)

SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Table of contents
22

33
* [C++ High Performance Computing Optimization Guide](README.md)
4-
* [中文版本](README.zh.md)
4+
* [中文版本](README.zh-CN.md)
55
* [Contributing](CONTRIBUTING.md)
66
* [参与贡献](CONTRIBUTING.zh.md)
77
* [Learning Path](docs/en/learning-path.md)

changelog/2026-02-27.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- 细化 **Success Metrics**:明确 JSON 输出要求、10% 回归阈值、双语文档同步要求。
1515

1616
#### design.md
17-
- 更新**目录结构**与实际项目一致:补充 `tests/``changelog/``README.zh.md``CLAUDE.md``docs/` 改为 `zh/` + `en/` 双语子目录;补充 `sanitizers.yml` 工作流。
17+
- 更新**目录结构**与实际项目一致:补充 `tests/``changelog/``README.zh-CN.md``CLAUDE.md``docs/` 改为 `zh/` + `en/` 双语子目录;补充 `sanitizers.yml` 工作流。
1818
- 更新**架构图**:新增 Testing 子图(Unit Tests、Property Tests、Integration Tests)及其与模块、CI 的依赖关系。
1919
- 更新 **CMake 预设模型**:从 4 个简化 preset 扩展为 7 个完整 preset 的说明表,新增 CMake 选项表(HPC_BUILD_TESTS、HPC_BUILD_BENCHMARKS、HPC_ENABLE_OPENMP 等)。
2020
- 修复 **SIMD dispatch 模板设计缺陷**:将所有参数统一为 `Func&&` 改为四个独立模板参数 `ScalarFn/SseFn/AvxFn/Avx512Fn`
@@ -41,7 +41,7 @@
4141
### 项目全面优化
4242

4343
#### Bug / 功能性修复(高优先级)
44-
- **README 徽章 URL**:将 `YOUR_USERNAME` 替换为 `LessUp``README.md``README.zh.md`)。
44+
- **README 徽章 URL**:将 `YOUR_USERNAME` 替换为 `LessUp``README.md``README.zh-CN.md`)。
4545
- **文档链接修复**`README.md` 中 docs 链接添加 `en/` 前缀(`docs/learning-path.md``docs/en/learning-path.md`)。
4646
- **MSVC 兼容性**:修复 `simd_utils.hpp``aligned_allocator` 在 Windows 下使用 `_aligned_malloc/_aligned_free` 而非 `posix_memalign`
4747
- **05-concurrency benchmark 注册**:将 `bench/atomic_bench.cpp``bench/openmp_bench.cpp` 注册到 CMakeLists.txt 中。

changelog/2026-03-06.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
- 新增中文跳转链接。
3838
- 将 Build / Benchmarks / Sanitizers 徽章替换为更醒目的 `for-the-badge` 样式。
3939
- 新增 GitBook 同步指南入口。
40-
- 优化 `README.zh.md`
40+
- 优化 `README.zh-CN.md`
4141
- 新增英文跳转链接。
4242
- 同步优化 3 个 GitHub Actions 徽章。
4343
- 新增 GitBook 接入指南入口。

0 commit comments

Comments
 (0)