Skip to content

Commit

Permalink
docs: Add "Missing dependencies" installation issue
Browse files Browse the repository at this point in the history
  • Loading branch information
acheroncrypto committed Oct 23, 2024
1 parent 0df6884 commit 3714924
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions docs/src/pages/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,6 @@ Install `avm` using Cargo. Note this will replace your `anchor` binary if you ha
cargo install --git https://github.com/coral-xyz/anchor avm --locked --force
```

On Linux systems you may need to install additional dependencies if cargo install fails. E.g. on Ubuntu:

```shell
sudo apt-get update && sudo apt-get upgrade && sudo apt-get install -y pkg-config build-essential libudev-dev libssl-dev
```

Install the latest version of the CLI using `avm`:

```shell
Expand All @@ -65,12 +59,6 @@ We can also use Cargo to install the CLI directly. Make sure that the `--tag` ar
cargo install --git https://github.com/coral-xyz/anchor --tag v0.30.1 anchor-cli --locked
```

On Linux systems you may need to install additional dependencies if cargo install fails. On Ubuntu,

```shell
sudo apt-get update && sudo apt-get upgrade && sudo apt-get install -y pkg-config build-essential libudev-dev
```

Now verify the CLI is installed properly.

```shell
Expand All @@ -79,6 +67,16 @@ anchor --version

## Issues

Installation might fail due to a variety of reasons. This section contains a list of the most common issues and their solutions.

### Missing dependencies

On Linux systems you may need to install additional dependencies. E.g. on Ubuntu:

```shell
sudo apt-get update && sudo apt-get upgrade && sudo apt-get install -y pkg-config build-essential libudev-dev libssl-dev
```

### Incorrect `$PATH`

Rust binaries, including `avm` and `anchor`, are installed to the `~/.cargo/bin` directory. Since this directory is required to be in the `PATH` environment variable, [Rust](#rust) installation tries to set it up automatically, but it might fail to do so in some platforms.
Expand Down

0 comments on commit 3714924

Please sign in to comment.