Skip to content

docs: README 重设计 — 核心特性、AI 辅助上手、贡献者指南#42

Merged
Sunrisepeak merged 6 commits into
mainfrom
docs/readme-redesign
May 16, 2026
Merged

docs: README 重设计 — 核心特性、AI 辅助上手、贡献者指南#42
Sunrisepeak merged 6 commits into
mainfrom
docs/readme-redesign

Conversation

@Sunrisepeak
Copy link
Copy Markdown
Member

改动

README 全面重设计,面向首次对外传播。

主要变化

部分 变化
标语 "一个现代C++构建工具" → "一个现代C++模块化构建工具 — 纯C++23模块编写,已实现自举"
核心特性 新增 5 bullet 亮点(模块原生支持/自举/开箱即用/依赖管理/Workspace)
为什么选择 mcpp 新增章节:专为模块化打造、文件级增量、一键创建、模块化生态
安装 新增"方式三:让 AI 助手帮你安装"
功能概览 折叠式详情(构建系统/工具链/包管理/Workspace/打包/开发体验)
参与贡献 新增 AI Agent 参与流程(issue → PR → 给 Agent 的上下文)
平台矩阵 Clang/LLVM 更新为 ✅
WIP 声明 从开头 CAUTION 移到末尾 NOTE
Badge 新增 Release 版本号 + Self-hosted badge

不合入,供页面 review

PR 创建后请在 GitHub 页面上直接查看渲染效果。

- Rewrite tagline: emphasize pure C++23 modules + self-hosted
- Add core features section (5 bullets)
- Add "why mcpp" section focused on module-first experience
- Add AI-assisted install (方式三) and AI learning prompt
- Add contributor section with AI Agent workflow guidance
- Reorganize feature overview into collapsible sections
- Update platform matrix (Clang/LLVM now supported)
- Move WIP notice to end of file
- Add Release + Self-hosted badges
- Move WIP notice from bottom to after "why mcpp" section
- Soften "Linux上体验最好的选择" wording
- Change AI prompts to copyable code blocks with repo URL
- Simplify contributing section, reference .agents/skills/
- Add .agents/skills/contributing.md (agent contribution guide)
- Add .agents/skills/mcpp-usage.md (agent usage guide)
- .agents/skills/contributing.md → .agents/skills/mcpp-contributing/SKILL.md
- .agents/skills/mcpp-usage.md → .agents/skills/mcpp-usage/SKILL.md
- Both skills now have YAML frontmatter (name, description)
- Update README references to new skill paths
@Sunrisepeak Sunrisepeak marked this pull request as ready for review May 16, 2026 00:43
@Sunrisepeak Sunrisepeak merged commit 0d7e02a into main May 16, 2026
1 check passed
@Sunrisepeak Sunrisepeak mentioned this pull request May 16, 2026
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