Skip to content

Commit

Permalink
docs: update installation docs to say that cmake is needed
Browse files Browse the repository at this point in the history
Since we enabled the `zlib-ng` feature from `gix` in 2412fd4, `cmake`
is needed when installing from source.
  • Loading branch information
martinvonz committed Dec 6, 2024
1 parent f58145b commit b7ba3fc
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions docs/install-and-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ be compiled from the same source code.

#### From Source

First make sure that you have a Rust version >= 1.76 and that the `libssl-dev`,
`openssl`, `pkg-config`, and `build-essential` packages are installed by running
something like this:
First make sure that you have a Rust version >= 1.76 and that the `cmake`,
`libssl-dev`, `openssl`, `pkg-config`, and `build-essential` packages are
installed by running something like this:

```shell
sudo apt-get install libssl-dev openssl pkg-config build-essential
sudo apt-get install cmake libssl-dev openssl pkg-config build-essential
```

Now run either:
Expand Down Expand Up @@ -139,6 +139,7 @@ these:

```shell
xcode-select --install
brew install cmake
brew install openssl
brew install pkg-config
export PKG_CONFIG_PATH="$(brew --prefix)/opt/openssl@3/lib/pkgconfig"
Expand Down Expand Up @@ -180,7 +181,14 @@ sudo port install jujutsu

### Windows

First make sure that you have a Rust version >= 1.76. Now run either:
First make sure that you have a Rust version >= 1.76. You will also need
`cmake`, which you can install by running this:

```shell
winget install cmake
```

Now run either:

```shell
# To install the *prerelease* version from the main branch
Expand Down

0 comments on commit b7ba3fc

Please sign in to comment.