修复build.md中命令描述错误并补充相关内容 #261
Conversation
修复了原本关于依赖库同步的错误，即原本编译指南约第七行提示运行： git submodule --init --recursive 实际上此命令并不完整，并不会正确同步，因此改为 git submodule update --init --recursive 除此以外还补充了关于build_commands.bat的使用方法，帮助初学者或是刚clone库的开发者比较快捷地完成编译
WalkthroughThis change updates the instructions in the BUILD.md file. The submodule command has been modified from using Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant B as build_commands.bat
participant E as Compiler Environment
U->>B: Run build_commands.bat
B->>E: Check for MinGW/Visual Studio configuration
E-->>B: Return environment status
B->>E: Trigger compilation process
E-->>B: Compile code and output to build folder
B->>U: Notify completion
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
BUILD.md (1)
25-44: Well-structured "快速编译" section addition.
This new section clearly explains how to quickly compile the code on Windows using a batch script. The instructions are detailed and list supported environments (MinGW, various Visual Studio versions), which is very helpful for beginners.A couple of minor points for refinement:
- Script Filename Consistency: The text refers to the batch file as
build_commands.batwhile earlier indications mentionedbuild_command.bat. Please confirm that the filename is consistent with the actual file in the repository.- Markdown List Indentation: The unordered list items on lines 33–41 are indented with a single space. Markdown lint (MD007) expects the list markers to start at the beginning of the line. Consider removing the extra space to adhere to conventional Markdown formatting. For example:
- - MinGW - - Visual Studio 2008 - - Visual Studio 2010 - - Visual Studio 2012 - - Visual Studio 2013 - - Visual Studio 2015 - - Visual Studio 2017 - - Visual Studio 2019 - - Visual Studio 2022 + - MinGW + - Visual Studio 2008 + - Visual Studio 2010 + - Visual Studio 2012 + - Visual Studio 2013 + - Visual Studio 2015 + - Visual Studio 2017 + - Visual Studio 2019 + - Visual Studio 2022Otherwise, the additional details and instructions are clear and beneficial.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
33-33: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
BUILD.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
BUILD.md
33-33: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🔇 Additional comments (1)
BUILD.md (1)
7-7: Correct Git submodule command update.
The command has been correctly updated to
git submodule update --init --recursive
which ensures that the submodules are properly synchronized after cloning.
build.md中提示克隆源码后用
git submodule --init --recursive同步源码实际上不能正确同步，完整命令应当是
git submodule update --init --recursive除此以外补充了使用
build_command.bat快速编译的指南，方便初学者或者是需要快速编译的开发者比较快捷的获取最新版的静态库。Summary by CodeRabbit