[Part B] docs: build and run with xmake or with mcpp - #29
Open
Sunrisepeak wants to merge 1 commit into
Open
Conversation
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
from
September 13, 2026 07:40
ca6ee44 to
7f91cfa
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, what a project depending on xrgui must say itself (toolchain, accelerator) with src.hello's manifest as the example, 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.
Sunrisepeak
force-pushed
the
pr/docs-build-and-run
branch
from
September 13, 2026 08:21
7f91cfa to
c0260bc
Compare
Sunrisepeak
changed the title
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.
只有文档,一个 commit。Part B,配合 Part A(mcpp 构建支持)。
README.md的「快速运行」拆成两块:先「用 mcpp」(Windows / Linux / macOS:mcpp run -p src.hello、mcpp run -p src.examples、mcpp test),后「用 xmake」;两条链并存的说明作为> 注:收尾。docs/build-and-development.md:README 的文档表从一开始就链接到它,但仓库里一直没有这个文件。内容:两条构建链各自的环境要求、命令、生成资产的去向、目标与依赖对照、平台支持(含 macOS 上只对 Apple 生效的三处配置)、依赖 xrgui 的项目必须自己说的两件事(工具链、设备轴,以src.hello/mcpp.toml为例)、showcase 在 debug 构建下对 validation layer 的依赖、Windows 上 GUI 子系统的代价;文末链接 mcpp 仓库、文档、索引、插件仓库,以及给 AI 助手用的入口。对 xmake 的影响:无。
合并顺序:在 Part A 之后(文档描述的是 A 之后的仓库)。diff 基于 master,只有文档。
CI:master 自己的 xmake job 目前在 CI 的 toolset 上编不过(Part A 的第 1 个 commit 修它),所以这个 PR 上那个检查的结果不是本 PR 的。fork 上叠在 Part A 之上跑过全套 mcpp CI(Windows / Linux / macOS),全绿。