@@ -27,16 +27,14 @@ docs, and actual command output.
2727
2828## This Repository
2929
30- - ` README.md ` (` README.zh.md ` , ` README.zh.hant.md ` ) — entry point, quick start, agent prompt , links.
31- - ` docs/architecture.md ` (` .zh.md ` , ` .zh.hant.md ` ) — structure, mcpp conventions, dependencies, templates , CI.
30+ - ` README.md ` (` README.zh.md ` , ` README.zh.hant.md ` ) — entry point, current status, boundaries, roadmap , links.
31+ - ` docs/architecture.md ` (` .zh.md ` , ` .zh.hant.md ` ) — current structure, mcpp conventions, runtime boundaries , CI.
3232- ` .xlings.json ` — the project tool environment (which mcpp version builds this).
3333- ` mcpp.toml ` — package metadata, dependencies, dev-dependencies.
34- - ` src/mylib.cppm ` — the library module interface.
35- - ` tests/mylib_test.cpp ` — a gtest suite matching the ` mcpp test ` conventions.
36- - ` examples/basic/ ` — a standalone consumer package.
37- - ` templates/ ` — project templates shipped with the library (` basic ` , ` lib ` ).
38- - ` tools/template_smoke.sh ` — renders and builds every template against this checkout.
39- - ` .github/workflows/ci-{linux,macos,windows}.yml ` — per-platform CI.
34+ - ` src/cmp.cppm ` — the import-only CMP root module interface.
35+ - ` tests/cmp_test.cpp ` — the gtest import smoke test.
36+ - ` examples/basic/ ` — a standalone path-dependency consumer.
37+ - ` .github/workflows/ci-{linux,macos,windows}.yml ` — per-platform build, test, and example CI.
4038
4139## Upstream
4240
@@ -57,7 +55,7 @@ Use these to confirm:
5755
5856- Package index: https://github.com/mcpplibs/mcpp-index · https://mcpplibs.github.io/mcpp-index/
5957- mcpplibs organization: https://github.com/mcpplibs
60- - Reference library — small and close to this template : https://github.com/mcpplibs/cmdline
58+ - Reference library — small, with a package/module layout close to CMP's current baseline : https://github.com/mcpplibs/cmdline
6159- Reference library — templates, i18n, multi-module: https://github.com/mcpplibs/llmapi
6260
6361Check the index before adding a dependency; read ` cmdline ` /` llmapi ` when you want to see how a
@@ -76,7 +74,7 @@ public API, and tests without a custom `main()`.
7674
7775- xlings: https://github.com/openxlings/xlings
7876
79- This template pins its tools in ` .xlings.json ` . After entering the repository:
77+ This project pins its tools in ` .xlings.json ` . After entering the repository:
8078
8179``` bash
8280xlings install # installs mcpp into the PROJECT environment (xlings install mcpp -g for global)
@@ -85,11 +83,10 @@ mcpp --version
8583
8684## Common Tasks
8785
88- - ** Understand the template ** → ` README.md ` and ` docs/architecture.md ` .
86+ - ** Understand CMP's current baseline ** → ` README.md ` and ` docs/architecture.md ` .
8987- ** Confirm an ` mcpp.toml ` field** → ` mcpp.toml ` , the [ ` mcpp ` ] ( ../mcpp/SKILL.md ) skill, then upstream ` docs/05-mcpp-toml.md ` .
9088- ** Add a dependency** → the [ ` mcpp-index ` ] ( ../mcpp-index/SKILL.md ) skill, then ` mcpplibs/cmdline ` for a real example.
9189- ** Add a module API** → ` mcpp-style-ref ` , then edit ` src/*.cppm ` .
92- - ** Add a test** → follow ` tests/mylib_test .cpp ` , verify with ` mcpp test ` .
90+ - ** Add a test** → follow ` tests/cmp_test .cpp ` , verify with ` mcpp test ` .
9391- ** Add an example** → follow ` examples/basic/ ` — its own ` mcpp.toml ` with a path dependency.
94- - ** Add or change a template** → ` templates/<name>/ ` , verify with ` bash tools/template_smoke.sh ` .
9592- ** Publish the library** → the [ ` mcpp-index ` ] ( ../mcpp-index/SKILL.md ) skill.
0 commit comments