Merge pull request #11 from Awesome-Embedded-Learning-Studio/optimize/update_readme

feat: update the meta info of project

Author: Charliechen114514

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Charliechen
+Copyright (c) 2025-2026 Charliechen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.en.md

@@ -2,70 +2,79 @@
 
 [中文](README.md) | English
 
+> A systematic modern C++ tutorial -- from foundational syntax to embedded practice, with compilable code examples for every concept
+
+<p align="center">
+  <a href="https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeModernCPP/">
+    <img src="https://img.shields.io/badge/📖_Read_Docs_Online-Live-blue?style=for-the-badge" alt="Online Docs">
+  </a>
+</p>
+
 ![C++](https://img.shields.io/badge/C%2B%2B-11%20%7C%2014%20%7C%2017%20%7C%2020%20%7C%2023-blue?logo=c%2B%2B)
 ![Release](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
 ![License](https://img.shields.io/github/license/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
-![Stars](https://img.shields.io/github/stars/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
-![Issues](https://img.shields.io/github/issues/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
 ![Build](https://img.shields.io/github/actions/workflow/status/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/deploy.yml?branch=main)
-[![Docs](https://img.shields.io/badge/docs-online-blue)](https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeModernCPP/)
-
-> A systematic modern C++ tutorial -- from foundational syntax to embedded practice, from the standard library in depth to concurrent programming, with compilable code examples for every concept
 
 ---
 
 ## Highlights
 
-- **Systematic Learning Path** -- 8 volumes from beginner to advanced, each with clear prerequisites, building progressively
-- **Practice-Driven** -- Every concept comes with a compilable CMake project, not isolated code snippets
-- **Multi-Platform Coverage** -- STM32 / ESP32 / RP2040 embedded practice, going beyond desktop
-- **Tag Navigation** -- Browse articles by topic, C++ standard, difficulty, platform, and more
-- **Online Reading** -- MkDocs documentation site with search and navigation
+- **9-Volume System** -- From C crash course to embedded practice, forming a complete learning loop
+- **Compilable Examples** -- Every concept comes with a CMake project, not isolated code snippets
+- **Embedded Practice** -- STM32 / ESP32 / RP2040 multi-platform real hardware projects
+- **Tag Navigation** -- Browse articles by topic, C++ standard, difficulty, and platform
+- **Online Reading** -- Full-featured documentation site with search, navigation, and dark mode
 
 ---
 
 ## Content Architecture
 
 ```mermaid
 graph LR
-    V1["Volume 1 Fundamentals"] --> V2["Volume 2 Modern Features"]
-    V2 --> V3["Volume 3 Std Library"] & V4["Volume 4 Advanced"] & V5["Volume 5 Concurrency"] & V6["Volume 6 Performance"] & V7["Volume 7 Engineering"]
-    V2 --> V8["Volume 8 Domain Apps"]
+    V1["Vol.1 Fundamentals"] --> V2["Vol.2 Modern Features"]
+    V2 --> V3["Vol.3 Std Library"] & V4["Vol.4 Advanced"] & V5["Vol.5 Concurrency"] & V6["Vol.6 Performance"] & V7["Vol.7 Engineering"]
+    V2 --> V8["Vol.8 Domain Apps"]
     V8 --> E["Embedded"] & N["Networking"] & G["GUI"] & D["Data"] & A["Algorithms"]
+    V2 --> V9["Vol.9 Open Source"]
+    V9 --> OC["Chrome Code Study"] & OS["Other Projects"]
 ```
 
-### Tutorial Structure
+<details>
+<summary>Volume details and progress</summary>
 
 | Volume | Topic | Articles | Difficulty | Status |
 |:--:|------|:------:|:----:|:----:|
 | 1 | [C++ Fundamentals](documents/vol1-fundamentals/) -- types, control flow, functions, pointers, classes, template basics | 49 | beginner | Completed |
-| 2 | [Modern C++ Features](documents/vol2-modern-features/) -- move semantics, smart pointers, constexpr, Lambda | 35-40 | intermediate | Completed |
+| 2 | [Modern C++ Features](documents/vol2-modern-features/) -- move semantics, smart pointers, constexpr, Lambda | 44 | intermediate | Completed |
 | 3 | [Standard Library In Depth](documents/vol3-standard-library/) -- containers, iterators, algorithms, strings, allocators | 40-50 | intermediate | Planned |
 | 4 | [Advanced Topics](documents/vol4-advanced/) -- Concepts, Ranges, coroutines, modules, template metaprogramming | 50-60 | advanced | Planned |
 | 5 | [Concurrent Programming](documents/vol5-concurrency/) -- thread primitives, atomic operations, lock-free programming, async I/O | 25-30 | advanced | Planned |
 | 6 | [Performance Optimization](documents/vol6-performance/) -- CPU cache, SIMD, reading assembly, benchmarking | 18-22 | advanced | Planned |
 | 7 | [Software Engineering Practices](documents/vol7-engineering/) -- CMake, testing, static analysis, DevOps | 30-35 | intermediate | Planned |
 | 8 | [Domain Applications](documents/vol8-domains/) -- embedded / networking / GUI / data storage / algorithms | 80-100 | intermediate | In Progress |
+| 9 | [Open Source Project Study](documents/vol9-open-source-project-learn/) -- reading and analyzing open source codebases | 13+ | intermediate | In Progress |
 | - | [Compilation & Linking In Depth](documents/compilation/) -- preprocessing, assembly, linking, debug symbols | 10+ | intermediate | Completed |
 | - | [Capstone Projects](documents/projects/) -- hand-rolled STL, mini HTTP server, embedded OS | - | advanced | Planned |
 
+</details>
+
 ---
 
 ## Learning Paths
 
 ```mermaid
 flowchart TD
     subgraph PathA["Path A -- C and Embedded Experience"]
-        A1["Volume 2: Modern C++ Features"] --> A2["Volume 8: Embedded Development"]
+        A1["Vol.2: Modern C++ Features"] --> A2["Vol.8: Embedded Development"]
     end
     subgraph PathB["Path B -- C++ Experience"]
-        B1["Volume 8: Fundamentals Review"] --> B2["Platform Tutorials"] --> B3["RTOS Practice"]
+        B1["Vol.8: Fundamentals Review"] --> B2["Platform Tutorials"] --> B3["RTOS Practice"]
     end
     subgraph PathC["Path C -- Both"]
         C1["Jump to any topic of interest"]
     end
     subgraph PathD["Path D -- Complete Beginner"]
-        D1["Volume 1: C++ Fundamentals (incl. C crash course)"] --> D2["Volume 2: Modern C++ Features"]
+        D1["Vol.1: C++ Fundamentals (incl. C crash course)"] --> D2["Vol.2: Modern C++ Features"]
     end
     Start(["Your starting point?"]) -->|"C + Embedded"| PathA
     Start -->|"C++ Experience"| PathB
@@ -112,30 +121,28 @@ cd Tutorial_AwesomeModernCPP
 
 ---
 
-## Version History
+<details>
+<summary>Version history / Branches / Directory structure</summary>
+
+**Version History**
 
 | Version | Date | Notes |
 |------|------|------|
 | [v0.1.0](changelogs/v0.1.0.md) | 2026-04-29 | Initial public release -- Vol 1/2, compilation, and embedded tutorials |
 
 See [changelogs/](changelogs/) for full release history.
 
----
-
-## Branch Overview
+**Branch Overview**
 
 | Branch | Purpose | Status |
 |------|------|------|
 | `main` | Primary development branch | Active |
 | `archive/legacy_20260415` | Pre-restructuring archive | Read-only |
 | `gh-pages` | Auto-deployed documentation site | Auto-generated |
 
----
+**Project Directory Structure**
 
-<details>
-<summary>Project directory structure</summary>
-
-```
+```text
 Tutorial_AwesomeModernCPP/
 ├── documents/                  # Tutorial Markdown files
 │   ├── vol1-fundamentals/      # Volume 1: C++ Fundamentals (ch00-ch12 + C crash course)
@@ -151,10 +158,13 @@ Tutorial_AwesomeModernCPP/
 │   │   ├── gui-graphics/       #   GUI and Graphics
 │   │   ├── data-storage/       #   Data Storage
 │   │   └── algorithms/         #   Algorithms and Data Structures
+│   ├── vol9-open-source-project-learn/  # Volume 9: Open Source Project Study
 │   ├── compilation/            # Compilation & Linking In Depth
 │   ├── projects/               # Capstone Projects
 │   └── index.md                # Tutorial home page
 ├── code/                       # Example code
+│   ├── volumn_codes/vol1/      #   Volume 1 code and exercises
+│   └── examples/               #   Legacy code examples
 ├── scripts/                    # Developer tool scripts
 ├── todo/                       # Content planning and progress tracking
 └── mkdocs.yml                  # MkDocs site configuration
@@ -189,11 +199,5 @@ This project references the following excellent resources:
 
 - **License**: [MIT License](./LICENSE)
 - **Issues**: [Submit an issue](https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/issues)
-- **Email**: 725610365@qq.com
+- **Email**: <725610365@qq.com>
 - **Organization**: [Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio)
-
----
-
-<p align="center">
-  <b>Learn modern C++ systematically, from fundamentals to practice</b>
-</p>

README.md

@@ -2,25 +2,28 @@
 
 [English](README.en.md) | 中文
 
+> 一套系统化的现代 C++ 教程 -- 从基础语法到嵌入式实战，每个概念配有可编译的代码示例
+
+<p align="center">
+  <a href="https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeModernCPP/">
+    <img src="https://img.shields.io/badge/📖_在线阅读文档站-Live-blue?style=for-the-badge" alt="Online Docs">
+  </a>
+</p>
+
 ![C++](https://img.shields.io/badge/C%2B%2B-11%20%7C%2014%20%7C%2017%20%7C%2020%20%7C%2023-blue?logo=c%2B%2B)
 ![Release](https://img.shields.io/github/v/release/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
 ![License](https://img.shields.io/github/license/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
-![Stars](https://img.shields.io/github/stars/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
-![Issues](https://img.shields.io/github/issues/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP)
 ![Build](https://img.shields.io/github/actions/workflow/status/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/deploy.yml?branch=main)
-[![Docs](https://img.shields.io/badge/docs-online-blue)](https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeModernCPP/)
-
-> 一套系统化的现代 C++ 教程 -- 从基础语法到嵌入式实战，从标准库深入到并发编程，每个概念配有可编译的代码示例
 
 ---
 
 ## 特色亮点
 
-- **系统化学习路径** -- 9 卷从入门到高级，每卷有明确前置知识，循序渐进
-- **实战驱动** -- 每个概念配合可编译的 CMake 项目，而非孤立代码片段
-- **多平台覆盖** -- STM32 / ESP32 / RP2040 嵌入式实战，不止于桌面端
-- **标签导航** -- 按主题、C++ 标准、难度、平台等维度检索文章
-- **在线阅读** -- MkDocs 文档站，支持搜索与导航
+- **9 卷体系** -- 从 C 语言速通到嵌入式实战，形成完整学习闭环
+- **可编译示例** -- 每个概念配 CMake 工程，不是孤立的代码片段
+- **嵌入式实战** -- STM32 / ESP32 / RP2040 多平台真机项目
+- **标签导航** -- 按主题、C++ 标准、难度、平台多维检索
+- **在线阅读** -- 搜索、导航、暗色模式一应俱全的文档站
 
 ---
 
@@ -36,7 +39,8 @@ graph LR
     V9 --> OC["Chrome 代码研读"] & OS["其他开源项目"]
 ```
 
-### 教程结构
+<details>
+<summary>各卷详细内容与进度</summary>
 
 | 卷 | 主题 | 文章数 | 难度 | 状态 |
 |:--:|------|:------:|:----:|:----:|
@@ -52,6 +56,8 @@ graph LR
 | - | [编译与链接深入](documents/compilation/) -- 预处理、汇编、链接、调试符号 | 10+ | intermediate | 已完成 |
 | - | [贯穿式实战项目](documents/projects/) -- 手写 STL、迷你 HTTP 服务器、嵌入式 OS | - | advanced | 规划中 |
 
+</details>
+
 ---
 
 ## 学习路径
@@ -115,30 +121,28 @@ cd Tutorial_AwesomeModernCPP
 
 ---
 
-## 版本历史
+<details>
+<summary>版本历史 / 分支 / 目录结构</summary>
+
+**版本历史**
 
 | 版本 | 日期 | 说明 |
 |------|------|------|
 | [v0.1.0](changelogs/v0.1.0.md) | 2026-04-29 | 首个公开版本，卷一/卷二/编译卷/嵌入式教程 |
 
 完整变更记录见 [changelogs/](changelogs/) 目录。
 
----
-
-## 分支说明
+**分支说明**
 
 | 分支 | 用途 | 状态 |
 |------|------|------|
 | `main` | 主开发分支 | Active |
 | `archive/legacy_20260415` | 重构前存档 | Read-only |
 | `gh-pages` | 自动部署的文档站 | Auto-generated |
 
----
+**项目目录结构**
 
-<details>
-<summary>项目目录结构</summary>
-
-```
+```text
 Tutorial_AwesomeModernCPP/
 ├── documents/                  # 教程 Markdown 文件
 │   ├── vol1-fundamentals/      # 卷一：C++ 基础入门（ch00-ch12 + C 语言速通）
@@ -195,11 +199,5 @@ Tutorial_AwesomeModernCPP/
 
 - **许可证**：[MIT License](./LICENSE)
 - **Issues**：[提交问题](https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/issues)
-- **Email**：725610365@qq.com
+- **Email**：<725610365@qq.com>
 - **组织**：[Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio)
-
----
-
-<p align="center">
-  <b>系统化学习现代 C++，从基础到实战</b>
-</p>

documents/index.en.md

@@ -86,6 +86,14 @@ Practical applications of modern C++ across domains: embedded development, netwo
 
 ---
 
+### Volume 9: Open Source Project Study
+
+Learn industrial-grade C++ design and implementation by analyzing real open source codebases (e.g., Chromium).
+
+- [Start Reading](vol9-open-source-project-learn/index.md)
+
+---
+
 ### Compilation & Linking In-Depth
 
 Deep exploration of C/C++ compilation, linking, static libraries, dynamic libraries, symbol visibility, and related core concepts. 10 articles in total.

mkdocs.yml

@@ -4,7 +4,7 @@ site_author: Charliechen  # 作者名称,可以改成你的真实姓名或网名
 site_url: https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeModernCPP/
 
 # 版权信息,显示在页面底部
-copyright: Copyright © 2025 Charliechen - 保留所有权利
+copyright: Copyright © 2025-2026 Charliechen - 保留所有权利
 
 # 文档源文件夹
 docs_dir: "documents"
@@ -208,6 +208,7 @@ plugins:
             卷六 · 性能优化: Vol.6 - Performance
             卷七 · 工程实践: Vol.7 - Engineering
             卷八 · 领域应用: Vol.8 - Domains
+            卷九 · 开源项目学习: Vol.9 - Open Source Projects
             编译与链接: Compilation & Linking
             实战项目: Projects
             标签: Tags