update README.md#15
Conversation
There was a problem hiding this comment.
Pull request overview
This PR enhances the README.md documentation by clarifying build options and adding new documentation sections. The updates provide better guidance for users on how to build, run, and clean the rCore-Tutorial-v3 operating system across different chapters.
Key changes:
- Clarifies that default commands run unoptimized builds with debug info, and adds
--releaseflag documentation - Improves the description of the
--featuresparameter with more explicit syntax - Adds new sections documenting the build system (
cargo make) and cleanup commands (cargo clean)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| 可选参数： | ||
|
|
||
| - `--lab` 只对 ch1 有效，执行 ch1-lab |
There was a problem hiding this comment.
Inconsistency in wording: Line 65 uses "执行" (execute) while line 75 uses the same word. However, line 64 (unchanged) also uses "执行". Consider whether "执行" is the correct word for ch1-lab in the context of line 75, since this section is about compiling ("编译系统"), not running the system. The word "编译" might be more appropriate here.
| - `--lab` 只对 ch1 有效，执行 ch1-lab | |
| - `--lab` 只对 ch1 有效，编译 ch1-lab |
|
|
||
|
|
||
| ## 清空系统 | ||
| - 只清空第 `n` 章的编译生成的文件：`cargo clean -p ch<n>` |
There was a problem hiding this comment.
The description "只清空第 n 章的编译生成的文件" contains a syntax issue. The command shown is cargo clean -p ch<n> but the description refers to "第 n 章" which suggests the user should specify a chapter number. The command syntax should be clearer - it should be cargo clean -p ch1, cargo clean -p ch2, etc., not cargo clean -p chn. Consider clarifying that <n> should be replaced with an actual chapter number like 1, 2, 3, etc.
| - 只清空第 `n` 章的编译生成的文件：`cargo clean -p ch<n>` | |
| - 只清空指定章节（将 `<n>` 替换为章节号，如 1、2、3）的编译生成的文件：`cargo clean -p ch<n>` |
| 可选参数： | ||
|
|
||
| - `--lab` 只对 ch1 有效，执行 ch1-lab | ||
| - `--features <features>` 只有对 ch3 有效的 <features> 为 `coop` |
There was a problem hiding this comment.
Inconsistency in wording: Line 65 uses "目前只有对 ch3 有效的" while line 76 uses "只有对 ch3 有效的" (missing "目前"). For consistency, both lines should use the same wording since they describe the same feature parameter.
| - `--features <features>` 只有对 ch3 有效的 <features> 为 `coop` | |
| - `--features <features>` 目前只有对 ch3 有效的 <features> 为 `coop` |
No description provided.