You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: chapter 00 earns its definition, and the install section recommends one way
Two corrections from review, and both are about what a reader meets first.
CHAPTER 00 IS RESTRUCTURED. It opened with a metadata block -- reader, question,
exclusions -- which is a reference-chapter device and reads as machinery on the
front door. And it stated what mcpp is before saying what problem that answers.
It now runs background -> who pays -> what mcpp is -> the guarantee -> the
smallest example that shows it:
C++20 gave the language modules, and adopting them turned out to be a
build-system problem: scan for `import`, order the compiles, cache and
invalidate the interfaces, with a compiler new enough to have the feature --
and `import std` needs the standard library's own module built first. The gap
is concrete: this machine's g++ is 13.3.0 and cannot compile it.
A person pays an afternoon per machine. An agent pays context, in three places
before it writes a line: reading the build system, reconstructing the
environment it assumes, and following a header through its transitive includes
to find what is declared. Modules remove the third; mcpp removes the other two.
Rule 11 exempts `00` by name, with that reason in the script: it has no "not
here" to declare because everything else IS elsewhere, which its closing
paragraph says in a sentence.
THE INSTALL SECTION FOLLOWS R5. `xlings install mcpp -y` is the recommended way
and is the only one in the body. The standalone curl script and the per-host
default-toolchain table fold into a `<details>` -- they were offered at equal
weight, which asks a first-time reader to choose between two installs before
they have any basis to.
Copy file name to clipboardExpand all lines: docs/01-getting-started.md
+25-9Lines changed: 25 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,27 +14,43 @@ than repeats — and every field a manifest may hold, which is
14
14
15
15
## Installation
16
16
17
-
Supported hosts are Linux x86_64 / aarch64, macOS ARM64, and Windows x86_64. You do not need to install GCC, xlings, or any other build dependency beforehand.
18
-
On its first run, mcpp installs a default toolchain into an isolated sandbox (`~/.mcpp/`). The choice is host-aware: Linux x86_64 uses `gcc@16.1.0`; other Linux architectures use `gcc@15.1.0-musl`; macOS uses `llvm@20.1.7`; Windows uses `llvm@20.1.7` when usable MSVC is available and otherwise uses `gcc@16.1.0` for `x86_64-windows-gnu`.
17
+
Supported hosts are Linux x86_64 / aarch64, macOS ARM64, and Windows x86_64.
18
+
GCC, xlings and every other build dependency are installed by mcpp; none of them
19
+
has to be there first.
19
20
20
-
We recommend installing via [xlings](https://xlings.d2learn.org), which keeps mcpp isolated from your system environment:
21
+
**The recommended way is [xlings](https://xlings.d2learn.org)**, which keeps
22
+
mcpp isolated from the system environment:
21
23
22
24
```bash
23
25
xlings install mcpp -y
24
26
```
25
27
26
-
Alternatively, on Linux x86_64/aarch64 or macOS ARM64, use the one-line
27
-
installer script (xlings is bundled, and everything is installed under
28
-
`~/.mcpp/`):
28
+
<details>
29
+
<summary>Other ways: the standalone script, and what the first run installs</summary>
30
+
31
+
On Linux x86_64/aarch64 or macOS ARM64 a one-line installer bundles xlings and
32
+
puts everything under `~/.mcpp/`. It does not support Windows, where the
33
+
PowerShell xlings command in the README is the way in.
The script does not support Windows; install through the PowerShell xlings
35
-
command in the README instead.
39
+
On its first run mcpp installs a default toolchain into `~/.mcpp/`, chosen for
40
+
the host:
41
+
42
+
| host | default |
43
+
|---|---|
44
+
| Linux x86_64 |`gcc@16.1.0`|
45
+
| other Linux architectures |`gcc@15.1.0-musl`|
46
+
| macOS |`llvm@20.1.7`|
47
+
| Windows with usable MSVC |`llvm@20.1.7`|
48
+
| Windows without it |`gcc@16.1.0` for `x86_64-windows-gnu`|
49
+
50
+
Full installation instructions, including Windows, are in the
51
+
["Installation" section of the README](../README.md#install).
36
52
37
-
For full installation instructions (including xlings install commands, Windows support, and more), see the ["Installation" section of the README](../README.md#install).
53
+
</details>
38
54
39
55
Once installation is complete, start a new shell session, then verify:
0 commit comments