Skip to content

Commit

Permalink
Merge pull request #1265 from axodotdev/install
Browse files Browse the repository at this point in the history
doc(install): update install page
  • Loading branch information
Gankra authored Aug 2, 2024
2 parents 44b9941 + ddab4c9 commit 7eeb4c3
Showing 1 changed file with 29 additions and 11 deletions.
40 changes: 29 additions & 11 deletions book/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,59 @@ Surprise! The tool for prebuilt shippable binaries has way too many ways to inst
Whichever way you choose to install it, it should be invocable as `cargo dist ...`. If you insist on invoking the binary directly as `cargo-dist` you must still add the extra `dist` arg and invoke it as `cargo-dist dist ...` (a quirk of the way cargo invokes subcommands).


## Use The Installer Scripts
## Pre-built binaries

macOS and Linux (not NixOS, Alpine, or Asahi):
We provide several options to access pre-built binaries for a variety of platforms. If you would like to manually download a pre-built binary, checkout [the latest release on GitHub](https://github.com/axodotdev/cargo-dist/releases/latest).

### Installer scripts

#### macOS and Linux (not NixOS):

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/latest/download/cargo-dist-installer.sh | sh
```

Windows PowerShell:
#### Windows PowerShell:

```sh
powershell -c "irm https://github.com/axodotdev/cargo-dist/releases/latest/download/cargo-dist-installer.ps1 | iex"
```

## Build From Source With Cargo
### Package managers

#### Homebrew

```sh
cargo install cargo-dist --locked
brew install axodotdev/tap/cargo-dist
```

#### Pacman (Arch Linux)

## Install Prebuilt Binaries With cargo-binstall
Arch Linux users can install `cargo-dist` from the [extra repository](https://archlinux.org/packages/extra/x86_64/cargo-dist/) using [pacman](https://wiki.archlinux.org/title/Pacman):

```sh
pacman -S cargo-dist
```

### Other Options

#### cargo-binstall

```sh
cargo binstall cargo-dist
```

## Installation on Arch Linux
## Build From Source

Arch Linux users can install `cargo-dist` from the [extra repository](https://archlinux.org/packages/extra/x86_64/cargo-dist/) using [pacman](https://wiki.archlinux.org/title/Pacman):
For users who need to install cargo-dist on platforms that we do not yet provide pre-built binaries for, you will need to build from source.
`cargo-dist` is written in [Rust] and uses [cargo] to build. Once you've [installed the Rust toolchain (`rustup`)], run:

```sh
pacman -S cargo-dist
cargo install cargo-dist --locked
```

## Download Prebuilt Binaries From Github Releases
[Rust]: https://rust-lang.org
[cargo]: https://doc.rust-lang.org/cargo/index.html
[installed the Rust toolchain (`rustup`)]: https://rustup.rs/


[See The Latest Release](https://github.com/axodotdev/cargo-dist/releases/latest)!

0 comments on commit 7eeb4c3

Please sign in to comment.