[Part B] docs: build and run with xmake or with mcpp, and the two project templates - #10
Open
Sunrisepeak wants to merge 1 commit into
Open
[Part B] docs: build and run with xmake or with mcpp, and the two project templates#10Sunrisepeak wants to merge 1 commit into
Sunrisepeak wants to merge 1 commit into
Conversation
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
from
September 12, 2026 19:12
28a909e to
3deaf6f
Compare
Sunrisepeak
changed the base branch from
base/upstream-master
to
pr/mcpp-build-support
September 12, 2026 19:12
Sunrisepeak
changed the title
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
from
September 12, 2026 19:44
3deaf6f to
2206c15
Compare
Sunrisepeak
force-pushed
the
pr/mcpp-build-support
branch
from
September 12, 2026 19:50
8a229c2 to
7c3d8a0
Compare
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
2 times, most recently
from
September 12, 2026 19:59
5a84e7a to
076bf57
Compare
Sunrisepeak
force-pushed
the
pr/mcpp-build-support
branch
from
September 12, 2026 20:10
92d2971 to
aa3c2a5
Compare
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
from
September 12, 2026 20:10
076bf57 to
6138aeb
Compare
Sunrisepeak
force-pushed
the
pr/mcpp-build-support
branch
from
September 12, 2026 20:19
aa3c2a5 to
561b2fb
Compare
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
from
September 12, 2026 20:19
6138aeb to
4db69b5
Compare
README's quick-run becomes two blocks, mcpp first (it covers three platforms) and xmake second, closed by a note that the two chains build the same tree. docs/build-and-development.md -- linked from the README's table since the beginning but never present -- states what each chain needs, the commands, where generated assets go, targets and dependencies side by side, platform support including the three Apple-only configurations, the two templates and what a template project must say itself (toolchain, accelerator), the showcase's need for the validation layer in a debug build, and the Windows GUI subsystem's cost. Links to the mcpp repository, index, plugins and the AI skill entry close it. Other pages follow the entry points to templates/.
Sunrisepeak
force-pushed
the
pr/mcpp-build-support
branch
from
September 12, 2026 21:03
561b2fb to
7e82066
Compare
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
from
September 12, 2026 21:03
b6b2f30 to
8138240
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part B / 2(Part A:#11,mcpp 构建支持)。只有文档,没有代码;一个 commit。
内容
README.md的「快速运行」拆成两块:先「用 mcpp」(Windows / Linux / macOS:mcpp run xrgui_hello、--features examples --release、mcpp new myapp --template xrgui:hello),后「用 xmake」;两条链并存的说明作为> 注:放在这一节末尾。docs/build-and-development.md:README 的文档表从一开始就链接到它,但仓库里一直没有这个文件。内容:两条构建链各自的环境要求、命令、生成资产的去向、目标与依赖对照、平台支持(三个平台一张表,macOS 行说明只对 Apple 生效的三处配置)、两个模板和消费者必须自己说的两件事(Linux 工具链、设备轴)、showcase 在 debug 构建下对 validation layer 的依赖、Windows 上 GUI 子系统的代价;文末链接 mcpp 仓库、文档、索引、插件仓库,以及 mcpp 仓库里给 AI 助手用的 skill 入口和一段可直接发给助手的提示。PROJECT_INTRO.md、properties/showcase/quick_start.md、layout_doc.md里src.hello/main.cpp和src.examples/main.cpp的引用,跟随 Part A 改到templates/下。对 xmake 的影响:无。
合并顺序:在 Part A 之后。base 就是 Part A 的分支,所以这里的 diff 只有文档,而 CI 跑在「A 加文档」的树上;A 合并后把 base 换回 master 即可。