Skip to content

Commit adf90cc

Browse files
committed
Make clear that cmake is required for the max configuration (#1572)
1 parent 49bca2a commit adf90cc

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Diff for: README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -198,20 +198,20 @@ There are various build configurations, all of them are [documented here](https:
198198
for packagers who need to tune external dependencies.
199199

200200
```
201-
# A certain way to install `gitoxide` with just Rust and a C compiler installed.
201+
# A way to install `gitoxide` with just Rust and a C compiler installed.
202202
# If there are problems with SSL certificates during clones, try to omit `--locked`.
203203
cargo install gitoxide --locked --no-default-features --features max-pure
204204
205-
# The default installation, 'max', is the fastest, but also needs some libraries available to build successfully.
206-
# Installing these is platform-dependent and thus can't be explained here.
205+
# The default installation, 'max', is the fastest, but also needs `cmake` to build successfully.
206+
# Installing it is platform-dependent.
207207
cargo install gitoxide
208208
209-
# For smaller binaries and even faster build times that are traded for a less fancy CLI implementation, use `lean`
210-
# or `lean-termion` respectively.
209+
# For smaller binaries and even faster build times that are traded for a less fancy CLI implementation,
210+
# use the `lean` feature.
211211
cargo install gitoxide --locked --no-default-features --features lean
212212
```
213213

214-
The following installs the latest unpublished release directly from git:
214+
The following installs the latest unpublished `max` release directly from git:
215215

216216
```sh
217217
cargo install --git https://github.com/Byron/gitoxide gitoxide

0 commit comments

Comments
 (0)