Skip to content

docs: Install options (with AUR) + "Who's Using mcpp" section #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sunrisepeak merged 1 commit into from
Jun 25, 2026
Merged

docs: Install options (with AUR) + "Who's Using mcpp" section #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 40 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ mcpp is built specifically for **C++23 module-first development**. If you want t

### Install

**Option 1: install via xlings (recommended)**
**Install via xlings** (recommended)

```bash
xlings install mcpp -y
Expand All @@ -67,15 +67,35 @@ irm https://d2learn.org/xlings-install.ps1.txt | iex

</details>

**Option 2: one-line install script**
**Other options**

<details>
<summary><b>Option 1</b> — one-line install script</summary>

```bash
curl -fsSL https://github.com/mcpp-community/mcpp/releases/latest/download/install.sh | bash
```

Installs into `~/.mcpp/` and adds it to your shell PATH. Deleting `~/.mcpp` uninstalls cleanly.

**Option 3: let an AI assistant install it for you**
</details>

<details>
<summary><b>Option 2</b> — Arch Linux (AUR)</summary>

```bash
yay -S mcpp-bin # prebuilt release binary
yay -S mcpp-m # or build from source (bootstrapped with mcpp-bin)
```

Installs the `mcpp` command system-wide; per-user data still lives in `~/.mcpp/`.
On Arch the name `mcpp` is an unrelated C preprocessor, so the packages are
`mcpp-bin` / `mcpp-m` (see [`scripts/aur/`](scripts/aur/)).

</details>

<details>
<summary><b>Option 3</b> — let an AI assistant install it for you</summary>

Copy the following prompt to your AI coding assistant (Claude Code / Cursor / Copilot, etc.):

Expand All @@ -85,6 +105,8 @@ then install mcpp for me and create a C++23 module project, build and run it.
The repo's .agents/skills/mcpp-usage/SKILL.md has a detailed usage guide.
```

</details>

### Create, build & run a project

```bash
Expand Down Expand Up @@ -246,6 +268,21 @@ https://github.com/mcpp-community/mcpp repository,
then tell me how to create a C++23 module project with dependencies using mcpp.
```

## Who's Using mcpp

Real projects built with mcpp — `import`-able C++23 modules and the toolchain it builds on:

| Project | Description |
| --- | --- |
| [mcpp](https://github.com/mcpp-community/mcpp) | mcpp itself — 43+ C++23 modules, fully self-hosted |
| [xlings](https://github.com/openxlings/xlings) | Toolchain & package-management foundation mcpp builds on |
| [tinyhttps](https://github.com/mcpplibs/tinyhttps) | Minimal C++23 HTTP/HTTPS client with SSE streaming |
| [llmapi](https://github.com/mcpplibs/llmapi) | Modern C++ LLM API client (OpenAI-compatible) |
| [imgui-m](https://github.com/mcpplibs/imgui-m) | Dear ImGui as a C++23 module package |
| [cmdline](https://github.com/mcpplibs/cmdline) | Command-line parsing library / framework (mcpp uses it) |

More modular libraries → [mcpplibs](https://github.com/mcpplibs) · package index → [mcpp-index](https://github.com/mcpp-community/mcpp-index)

## Contributing

Contributions via issues and PRs are welcome. The project accepts contributions developed with AI agents.
Expand Down
43 changes: 40 additions & 3 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ mcpp 专门为 **C++23 模块化开发** 打造。如果你想在项目中使用

### 安装

**方式一：使用 xlings 安装（推荐）**
**使用 xlings 安装**（推荐）

```bash
xlings install mcpp -y
Expand All @@ -67,15 +67,35 @@ irm https://d2learn.org/xlings-install.ps1.txt | iex

</details>

**方式二：一键安装脚本**
**其他方式**

<details>
<summary><b>方式 1</b> — 一键安装脚本</summary>

```bash
curl -fsSL https://github.com/mcpp-community/mcpp/releases/latest/download/install.sh | bash
```

安装到 `~/.mcpp/`，自动加进 shell PATH。删除 `~/.mcpp` 即可干净卸载。

**方式三：让 AI 助手帮你安装**
</details>

<details>
<summary><b>方式 2</b> — Arch Linux（AUR）</summary>

```bash
yay -S mcpp-bin # 预编译 release 二进制
yay -S mcpp-m # 或源码构建（用 mcpp-bin 自举）
```

系统级安装 `mcpp` 命令，每个用户的数据仍在各自的 `~/.mcpp/`。
Arch 上 `mcpp` 这个名字属于一个无关的 C 预处理器，所以包名是
`mcpp-bin` / `mcpp-m`（详见 [`scripts/aur/`](scripts/aur/)）。

</details>

<details>
<summary><b>方式 3</b> — 让 AI 助手帮你安装</summary>

将以下提示词复制给你的 AI 编码助手（Claude Code / Cursor / Copilot 等）：

Expand All @@ -85,6 +105,8 @@ curl -fsSL https://github.com/mcpp-community/mcpp/releases/latest/download/insta
项目的 .agents/skills/mcpp-usage/SKILL.md 有详细的使用指南。
```

</details>

### 创建项目 & 构建运行

```bash
Expand Down Expand Up @@ -246,6 +268,21 @@ import mcpplibs.cmdline;
告诉我如何用 mcpp 创建一个带依赖的 C++23 模块项目。
```

## 谁在使用 mcpp

用 mcpp 构建的真实项目 —— 可直接 `import` 的 C++23 模块,以及它所依赖的工具链:

| 项目 | 说明 |
| --- | --- |
| [mcpp](https://github.com/mcpp-community/mcpp) | mcpp 自身 —— 43+ 个 C++23 模块,完全自举 |
| [xlings](https://github.com/openxlings/xlings) | mcpp 依赖的工具链与包管理底座 |
| [tinyhttps](https://github.com/mcpplibs/tinyhttps) | 极简 C++23 HTTP/HTTPS 客户端,支持 SSE 流式 |
| [llmapi](https://github.com/mcpplibs/llmapi) | 现代 C++ LLM API 客户端(OpenAI 兼容) |
| [imgui-m](https://github.com/mcpplibs/imgui-m) | Dear ImGui 的 C++23 模块封装包 |
| [cmdline](https://github.com/mcpplibs/cmdline) | 命令行解析库/框架(mcpp 自身在用) |

更多模块化库 → [mcpplibs](https://github.com/mcpplibs) · 包索引 → [mcpp-index](https://github.com/mcpp-community/mcpp-index)

## 参与贡献

欢迎通过 Issue 和 PR 参与项目开发。项目接受开发者使用 AI Agent 参与开发与贡献。
Expand Down
Loading