docs: add comprehensive installation guide and improve documentation#10
docs: add comprehensive installation guide and improve documentation#10
Conversation
- Add INSTALLATION.md with detailed Chinese installation tutorial - Add installer interface screenshot (docs/ege-installer.png) - Simplify code examples, redirect users to official website for more - Link installation guide prominently in README.md - Correct VS version support (VS 2017-2026, remove VS2010-2015 references) - Clarify Dev-C++ 64-bit only support - Auto-remove unsupported library files during build (VS2010-2015, Dev-C++ 32-bit)
Walkthrough更新项目以停止对 Visual Studio 2010–2015 和 Dev‑C++ 32 位的支持：移除相应库目录与引用，新增完整中文安装文档，更新 README 与 GitHub 指令说明，并在构建脚本中加入清理步骤以删除不再支持的库文件。 Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
诗
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 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. Comment |
🤖 Augment PR SummarySummary: Consolidates user-facing documentation around installing/using EGE via the installer and updates packaging/docs to reflect current supported IDE/library structure. Changes:
Technical Notes: Documentation and packaging changes align with the recent unified MSVC library layout and aim to reduce package size and user confusion. 🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
INSTALLATION.md
Outdated
| ``` | ||
|
|
||
| 2. **编写代码** | ||
| 创建 `main.cpp`，内容参见上方 [Visual Studio 示例](#📝-编写代码) |
There was a problem hiding this comment.
These internal links use an emoji in the fragment (e.g. #📝-编写代码), but GitHub’s generated heading IDs typically strip emojis, so the link may not resolve.
Severity: low
Other Locations
INSTALLATION.md:294INSTALLATION.md:525
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| all: $(TARGET) | ||
|
|
||
| $(TARGET): $(SRCS) | ||
| $(CXX) $(CXXFLAGS) $^ -o $@ $(LDFLAGS) |
There was a problem hiding this comment.
In the Makefile example, the recipe lines appear to be indented with spaces; make requires a leading tab for recipe commands, otherwise users will hit a “missing separator”/parse error.
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| $(CXX) $(CXXFLAGS) $^ -o $@ $(LDFLAGS) | ||
|
|
||
| clean: | ||
| del $(TARGET) |
There was a problem hiding this comment.
The clean target uses del, which only works in cmd.exe; if users follow the MSYS2/MinGW shell flow described above, make clean will fail.
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| del $(TARGET) | ||
|
|
||
| run: $(TARGET) | ||
| $(TARGET) |
There was a problem hiding this comment.
The run target executes $(TARGET) directly; in typical MSYS2/Unix-like shells the current directory isn’t on PATH, so this often won’t run unless invoked with an explicit path (which differs from the earlier ./main.exe example).
Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Fix all issues with AI agents
In @.github/copilot-instructions.md:
- Line 9: In the "Supported IDEs" line replace the inconsistent string "Red
Panda Dev-C++" with the canonical "Red Panda C++" so it matches other files;
locate the literal "Red Panda Dev-C++" in the Supported IDEs list and update it
to "Red Panda C++".
- Line 9: The supported IDEs list in the .github/copilot-instructions.md
currently omits CLion; update the line that starts with "**Supported IDEs**:
Visual Studio 2017-2026, MinGW-w64/MSYS2, Dev-C++, Code::Blocks, Red Panda
Dev-C++" to include "CLion" (matching README.md and INSTALLATION.md) so the
supported IDEs list is consistent across documentation.
In `@INSTALLATION.md`:
- Around line 285-287: Add a language identifier to the fenced code blocks in
INSTALLATION.md that currently show linker/library flags and other snippets
(e.g., the block containing "-lgraphics -lgdiplus -lgdi32 -limm32 -lmsimg32
-lole32 -loleaut32 -lwinmm -luuid -mwindows -static" and the blocks in the
ranges around lines 343-345, 416-427, 430-433) by changing the opening triple
backticks to include an appropriate language label such as text or bash (for
example use ```text or ```bash) so each code fence is explicitly labeled for
proper syntax highlighting; update all occurrences mentioned in the comment
accordingly.
- Line 183: 修复 README 链接失效：在 INSTALLATION.md 中将包含 emoji 的链接锚点（例如
`#📝-编写代码`、`#🔧-配置编译器` 以及另两处类似的 `#…` 链接）改为去掉 emoji 的锚点（例如
`#编写代码`、`#配置编译器`），确保链接文本或目标匹配 GitHub 生成的标题锚点；或者替换为显式 HTML 锚点/链接（如在标题处添加 <a
id="编写代码"></a> 并将链接指向 `#编写代码`）以保证跳转正确。
- Line 98: The heading "Visual Studio 2017 及更早版本" is misleading; update that
heading text (replace the "Visual Studio 2017 及更早版本" line) to explicitly
indicate this section covers the Visual Studio 2017 legacy/old UI and that VS
2015 and earlier are not supported (for example: "Visual Studio 2017（旧版界面，不支持 VS
2015 及更早版本）"), and ensure any nearby text mentions the installer does not
support VS2015 or earlier.
- Around line 485-492: The ordered list in the CLion setup section resets
numbering instead of continuing, breaking step flow; update the subsequent list
items (the second "1." entries shown in the diff) to continue the sequence
(change them to "3." and "4." or use explicit sequential numbering for the whole
block) so the Markdown renders a continuous 1–4 step sequence; locate the list
lines around the CLion steps (the "创建新项目" block and the following "配置
CMakeLists.txt" block) and adjust their numeric prefixes accordingly.
There was a problem hiding this comment.
Pull request overview
Adds a consolidated Chinese installation/usage guide as the primary user-facing documentation, updates existing docs to reflect current IDE/library support, and adjusts the packaging script to exclude unsupported library variants.
Changes:
- Added
INSTALLATION.mdwith step-by-step installation and per-IDE configuration guidance (plus screenshots and FAQ). - Updated
README.mdto link prominently to the new guide and clarify supported Visual Studio/Dev-C++ variants. - Updated
scripts/build.ps1to remove unsupported VS2010–2015 and Dev-C++ 32-bit libraries during packaging.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
scripts/build.ps1 |
Prunes unsupported library directories from the packaged xege_libs payload. |
README.md |
Improves Quick Start visibility of the new guide and updates support matrix/details. |
INSTALLATION.md |
New comprehensive Chinese installation and usage guide with IDE-specific sections. |
.github/copilot-instructions.md |
Updates repo metadata to reflect current supported IDE versions and library layout. |
INSTALLATION.md
Outdated
| ``` | ||
|
|
||
| 2. **编写代码** | ||
| 创建 `main.cpp`，内容参见上方 [Visual Studio 示例](#📝-编写代码) |
There was a problem hiding this comment.
The link target #📝-编写代码 is unlikely to match GitHub’s generated heading anchors (emoji are typically stripped), so this intra-doc link may be broken. Consider linking to a stable anchor (e.g., add an explicit HTML anchor) or link to the “快速入门示例” section instead.
| 创建 `main.cpp`，内容参见上方 [Visual Studio 示例](#📝-编写代码) | |
| 创建 `main.cpp`，内容参见上方 [快速入门示例](#快速入门示例) |
| $(CXX) $(CXXFLAGS) $^ -o $@ $(LDFLAGS) | ||
|
|
||
| clean: | ||
| del $(TARGET) | ||
|
|
||
| run: $(TARGET) | ||
| $(TARGET) |
There was a problem hiding this comment.
The Makefile example’s recipe lines appear to start with spaces. In Makefiles, commands must start with a literal TAB, otherwise make will fail with “missing separator”. Update the snippet to use tabs (and consider a shell-portable clean command if you expect MSYS2 bash users).
| $(CXX) $(CXXFLAGS) $^ -o $@ $(LDFLAGS) | |
| clean: | |
| del $(TARGET) | |
| run: $(TARGET) | |
| $(TARGET) | |
| $(CXX) $(CXXFLAGS) $^ -o $@ $(LDFLAGS) | |
| clean: | |
| rm -f $(TARGET) | |
| run: $(TARGET) | |
| $(TARGET) |
INSTALLATION.md
Outdated
| 1. **创建新项目** | ||
| - **File → New Project** | ||
| - 选择 **C++ Executable** | ||
| - 输入项目名称 | ||
|
|
||
|  | ||
|
|
||
| 1. **配置 CMakeLists.txt** | ||
|
|
There was a problem hiding this comment.
The numbered list restarts at 1 multiple times (e.g., after toolchain setup). This renders confusing step ordering. Renumber the steps so they progress sequentially (1,2,3,4…).
| # 移除不再支持的 VS2010-2015 库文件 | ||
| $UnsupportedVSLibs = @("vs2010", "vs2012", "vs2013", "vs2015", "vc2015") | ||
| foreach ($libDir in $UnsupportedVSLibs) { | ||
| $pathToRemove = Join-Path (Join-Path $LibsDir "lib") $libDir | ||
| if (Test-Path $pathToRemove) { | ||
| Log " Removing unsupported VS library: $libDir" | ||
| Remove-Item -Recurse -Force $pathToRemove | ||
| } |
There was a problem hiding this comment.
Remove-Item emits non-terminating errors by default, so a failed deletion here can leave unsupported VS libs in the package while the build still “succeeds”. Consider adding -ErrorAction Stop (and/or a post-delete Test-Path check) so packaging fails fast if the directory can’t be removed.
| # 移除 Dev-C++ 32位库文件（仅支持 64 位编译） | ||
| $devCpp32Path = Join-Path (Join-Path $LibsDir "lib") "devcpp\32" | ||
| if (Test-Path $devCpp32Path) { | ||
| Log " Removing Dev-C++ 32-bit library (unsupported)" | ||
| Remove-Item -Recurse -Force $devCpp32Path | ||
| } |
There was a problem hiding this comment.
Same as above: if removing the Dev-C++ 32-bit directory fails, the build may still succeed and ship unsupported artifacts. Add -ErrorAction Stop (and/or verify the directory is gone) to make failures visible.
INSTALLATION.md
Outdated
| **Visual Studio 2017 及更早版本:** | ||
|
|
||
| 1. **文件 → 新建 → 项目...** | ||
| 2. 选择 **Visual C++ → Win32 → Win32 控制台应用程序** | ||
| 3. 在向导中选择 **"空项目"** |
There was a problem hiding this comment.
This heading says “Visual Studio 2017 及更早版本”, but earlier in the same section the doc explicitly states VS2015 and earlier are not supported. Reword this to only refer to VS2017 (older UI) to avoid implying VS2015/2013/etc are supported.
- Fix IDE naming inconsistency: 'Red Panda Dev-C++' 'Red Panda C++' - Add missing CLion to supported IDE list in copilot-instructions.md - Clarify VS2017 heading: explicitly state VS2015 and earlier not supported - Fix broken emoji anchor links in INSTALLATION.md (#-编写代码 #编写代码) - Add language identifiers to code fences (text for linker params/flags) - Fix CLion section: correct ordered list numbering (1,2,1,1,2 1-5) and image indentation
What
Add complete Chinese installation and usage guide (INSTALLATION.md) as the primary user documentation, with improvements to existing documentation for clarity and consistency.
Why
How
User Documentation (INSTALLATION.md)
Project Documentation (README.md)
Build Process (scripts/build.ps1)
Metadata Updates (.github/copilot-instructions.md)
Testing
Summary by CodeRabbit
发布说明
新功能
文档
移除功能