add MSYS2/MinGW as compile option #288
Conversation
WalkthroughThe documentation file 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: 1
🧹 Nitpick comments (3)
docs/BUILD.md (3)
141-143: Avoid bare URLs in documentation.
Markdown style guidelines discourage using bare URLs. Please switch to link syntax for clarity and accessibility:Install MSYS2: [msys2.org](https://www.msys2.org/)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
143-143: Bare URL used
null(MD034, no-bare-urls)
145-149: Standardize heading punctuation.
Trailing colons in headings are unconventional and may impact readability. Remove the colon:-#### 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)
163-167: Clarify shell environment for building.
Building under MSYS2 requires using the “MSYS2 MinGW x64 UCRT64” shell (not the default MSYS shell) so that the correct toolchain and PATH are in effect. Please add a note to launch that environment before running:chmod a+x configure ./configure make -j4
📜 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)
docs/BUILD.md
Outdated
| ### Install libaries | ||
|
|
||
| ```bash | ||
| pacman -S mingw-w64-ucrt-x86_64-gcc | ||
| pacman -S mingw-w64-x86_64-qt5-base | ||
| pacman -S mingw-w64-x86_64-qt5-tools | ||
| pacman -S mingw-w64-x86_64-qt5-script | ||
| ``` |
There was a problem hiding this comment.
Fix typo and enhance package installation.
- Correct the typo in the heading:
libaries→libraries. - Precede installs with a full MSYS2 update (
pacman -Syu) to ensure package database and core packages are current. - Include the Qt5 SVG package (
mingw-w64-x86_64-qt5-svg) to match the Linux SVG dependency.
Apply this diff:
-### Install libaries
+#### Install libraries
+# Update MSYS2 package database and core system
+```bash
+pacman -Syu --noconfirm
+# After reopening the MSYS2 shell, finalize:
+pacman -Su --noconfirm
+```
-```bash
- pacman -S mingw-w64-ucrt-x86_64-gcc
- pacman -S mingw-w64-x86_64-qt5-base
- pacman -S mingw-w64-x86_64-qt5-tools
- pacman -S mingw-w64-x86_64-qt5-script
-```
+```bash
+pacman -S \
+ mingw-w64-ucrt-x86_64-gcc \
+ mingw-w64-x86_64-qt5-base \
+ mingw-w64-x86_64-qt5-tools \
+ mingw-w64-x86_64-qt5-script \
+ mingw-w64-x86_64-qt5-svg
+```
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/BUILD.md (2)
154-157: 🛠️ Refactor suggestionEnhance MSYS2 package installation
Precede installs with a full update, group packages in one command, and include the Qt5 SVG & script packages.-```bash -pacman -S mingw-w64-ucrt-x86_64-gcc -pacman -S mingw-w64-x86_64-qt5-tools -``` +```bash +# Update MSYS2 package database and core system +pacman -Syu --noconfirm +pacman -Su --noconfirm + +# Install required toolchain and Qt5 modules +pacman -S \ + mingw-w64-ucrt-x86_64-gcc \ + mingw-w64-x86_64-qt5-base \ + mingw-w64-x86_64-qt5-tools \ + mingw-w64-x86_64-qt5-script \ + mingw-w64-x86_64-qt5-svg \ + --noconfirm +```
152-152: 🛠️ Refactor suggestionFix typo and align heading level for the installation subsection
Correct the spelling and use the same H4 level you use elsewhere for substeps.-### Install libaries +#### Install libraries:
🧹 Nitpick comments (2)
docs/BUILD.md (2)
143-143: Convert bare URL to a markdown link
Avoid using a bare URL to satisfy Markdown lint rules and improve readability.-Install MSYS2: https://www.msys2.org/ +Install MSYS2: [MSYS2](https://www.msys2.org/)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
143-143: Bare URL used
null(MD034, no-bare-urls)
159-165: Clarify build environment and optimize parallel build
Recommend running these in the MinGW-w64 UCRT64 shell and leveraging all cores automatically.-#### Build - -```bash -chmod a+x configure -./configure -make -j4 -``` +#### Build + +> **Note:** Launch the **MSYS2 MinGW-w64 UCRT64** shell before proceeding. + +```bash +chmod a+x configure +./configure +# Use all available cores +make -j$(nproc) +```
📜 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)
🔇 Additional comments (1)
docs/BUILD.md (1)
141-141: Header consistency with existing sections
The H1 header# How to build with MinGW/MSYS2aligns well with the other platform-specific sections above.
|
This compiles fine for all executables. diec.exe can only be used at the moment. |
Summary by CodeRabbit