add MinGW/MSYS2 as compiling option #287
Conversation
WalkthroughA new section was added to the build documentation, providing step-by-step instructions for building the project using MinGW/MSYS2. The instructions detail repository cloning, package installation, and the build process, aligning with guidance for other supported platforms. Changes
Possibly related PRs
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (4)
docs/BUILD.md (4)
141-141: Standardize heading level for better hierarchy
The new section uses a top-level heading (#), matching other major build sections—but to improve document structure and accessibility, consider demoting it to a second-level heading (##). This avoids skipping levels when introducing subsections.Proposed diff:
-# How to build with MinGW/MSYS2 +## How to build with MinGW/MSYS2
143-150: Fix subheading levels, remove trailing punctuation, and correct typo
Static analysis flags show heading levels jumping too far (h1→h4) and trailing colons. Align all subsections at one level deeper (e.g.,###under##) and drop the colon. Also fix “libaries” → “libraries.”Proposed diff:
-#### Clone this repo recursively: +### Clone this repo recursively -### Install libaries +### Install libraries🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
143-143: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4(MD001, heading-increment)
143-143: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
153-155: Combine pacman installs and enable non-interactive mode
Running three separatepacman -Scommands can be condensed; adding--needed --noconfirmavoids extra prompts.Proposed diff:
-pacman -S mingw-w64-x86_64-qt5-base -pacman -S mingw-w64-x86_64-qt5-tools -pacman -S mingw-w64-x86_64-qt5-script +pacman -S --needed --noconfirm \ + mingw-w64-x86_64-qt5-base \ + mingw-w64-x86_64-qt5-tools \ + mingw-w64-x86_64-qt5-script
158-164: Clarify MSYS2 shell context before build
On Windows using MSYS2, users must open the correct MSYS2 MinGW shell (e.g., “MSYS2 MinGW 64-bit”) before running./configureandmake. Otherwise, the Qt packages won’t be found.Example note to add:
> **Note:** Launch the **MSYS2 MinGW 64-bit** shell before proceeding with the build steps below.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/BUILD.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/BUILD.md
143-143: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
143-143: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/BUILD.md (1)
169-193: 🛠️ Refactor suggestion
⚠️ Potential issueRemove duplicated MinGW/MSYS2 section
The "How to build with MinGW/MSYS2" section is duplicated, causing confusion (MD024). Consolidate into a single section by removing the duplicate block:@@ -169,25 +169,6 @@ -# How to build with MinGW/MSYS2 - -#### Clone this repo recursively: - -```bash -git clone --recursive https://github.com/horsicq/DIE-engine.git -cd DIE-engine -``` - -### Install libaries - -```bash -pacman -S mingw-w64-x86_64-qt5-base -pacman -S mingw-w64-x86_64-qt5-tools -pacman -S mingw-w64-x86_64-qt5-script -``` - -#### Build - -```bash -chmod a+x configure -./configure -make -j4 -```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
169-169: Multiple headings with the same content
null(MD024, no-duplicate-heading)
171-171: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4(MD001, heading-increment)
171-171: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
🧹 Nitpick comments (1)
docs/BUILD.md (1)
143-143: Convert bare URL to a Markdown link
Using a bare URL can trigger MD034. Wrap the MSYS2 URL in link syntax to improve readability and satisfy lint rules.
Apply this diff:-Install MSYS2: https://www.msys2.org/ +Install MSYS2: [MSYS2 website](https://www.msys2.org/)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
143-143: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/BUILD.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/BUILD.md
143-143: Bare URL used
null
(MD034, no-bare-urls)
145-145: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
145-145: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
169-169: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
171-171: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
171-171: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
|
|
||
| Install MSYS2: https://www.msys2.org/ | ||
|
|
||
| #### Clone this repo recursively: |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Normalize heading level and remove trailing colon
Jumping from an H1 (# How to build…) to an H4 (#### Clone…:) violates MD001, and trailing punctuation violates MD026. Use a consistent level (H2) and drop the colon:
-#### Clone this repo recursively:
+## Clone this repo recursively📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #### Clone this repo recursively: | |
| ## Clone this repo recursively |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
145-145: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
145-145: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
|
Closing in favour of #288 |
Summary by CodeRabbit