Skip to content

Commit

Permalink
Improve installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jaybosamiya committed Feb 13, 2024
1 parent 87818d8 commit 09bdfb3
Showing 1 changed file with 31 additions and 9 deletions.
40 changes: 31 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,41 @@ An opinionated formatter for [Verus] code.

## Installing and Using Verusfmt

Install the latest release using:
We support multiple install methods:

``` sh
cargo install verusfmt --locked
```
* [Latest release](https://github.com/jaybosamiya/verusfmt/releases/latest) using:

Alternatively, install the latest git commit using:
- <details><summary>Pre-built binary on Linux/MacOS (click to expand)</summary>

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/jaybosamiya/verusfmt/releases/latest/download/verusfmt-installer.sh | sh
```
</details>

- <details><summary>Pre-built binary on Windows (click to expand)</summary>

```sh
irm https://github.com/jaybosamiya/verusfmt/releases/latest/download/verusfmt-installer.ps1 | iex
```
</details>

- <details><summary>cargo install (click to expand)</summary>

``` sh
cargo install verusfmt --locked
```
</details>

* Bleeding-edge latest git commit

- <details><summary>cargo install (click to expand)</summary>

```sh
cargo install --git https://github.com/jaybosamiya/verusfmt --locked
```

```sh
cargo install --git https://github.com/jaybosamiya/verusfmt --locked
```

This will install the `verusfmt` binary. You can then run it on a file using:
These will install the `verusfmt` binary. You can then run it on a file using:

``` sh
verusfmt foo.rs
Expand Down

0 comments on commit 09bdfb3

Please sign in to comment.