Skip to content

Commit

Permalink
Make clear that cmake is required for the max configuration (#1572)
Browse files Browse the repository at this point in the history
  • Loading branch information
Byron committed Sep 2, 2024
1 parent 49bca2a commit adf90cc
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,20 +198,20 @@ There are various build configurations, all of them are [documented here](https:
for packagers who need to tune external dependencies.

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

The following installs the latest unpublished release directly from git:
The following installs the latest unpublished `max` release directly from git:

```sh
cargo install --git https://github.com/Byron/gitoxide gitoxide
Expand Down

0 comments on commit adf90cc

Please sign in to comment.