Skip to content

docs: add mcpp.toml project file guide#22

Merged
Sunrisepeak merged 1 commit into
mainfrom
docs/mcpp-toml-guide
May 10, 2026
Merged

docs: add mcpp.toml project file guide#22
Sunrisepeak merged 1 commit into
mainfrom
docs/mcpp-toml-guide

Conversation

@Sunrisepeak
Copy link
Copy Markdown
Member

Summary

Adds docs/05-mcpp-toml.md — a comprehensive guide to the mcpp.toml project file format, covering field reference, conventions, defaults, and 6 practical examples drawn from real mcpplibs projects.

Also updates the doc links in README.md and docs/README.md.

Test plan

  • All example snippets match actual field names in manifest.cppm
  • CI green

New `docs/05-mcpp-toml.md` covering:
- Minimal examples (bin + lib, 3-5 lines each)
- Full field reference ([package], [targets], [build], [lib],
  [dependencies], [dev-dependencies], [toolchain])
- 6 practical examples (hello world, modular lib + gtest, multi-dep
  app, pure C lib, mixed C/C++23, cross-compile static release)
- Convention & defaults cheat sheet

Also updates README.md doc section and docs/README.md index.
@Sunrisepeak Sunrisepeak merged commit fd50e79 into main May 10, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant