Skip to content

Commit

Permalink
README improvements
Browse files Browse the repository at this point in the history
- Remove old warning, now that verusfmt is successfully being used (and
  also under CI) for multiple projects
- Explicitly recommend pre-built binaries
  • Loading branch information
jaybosamiya-ms committed Jul 5, 2024
1 parent 6183c44 commit dd20acc
Showing 1 changed file with 12 additions and 24 deletions.
36 changes: 12 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@

An opinionated formatter for [Verus] code.

## WARNING

`verusfmt` is highly experimental code. Make backups of your files before trying
`verusfmt` on them.

## Updating verusfmt

If you've installed a pre-built binary, you can update to the latest release using
Expand All @@ -20,19 +15,21 @@ We support multiple install methods:

* [Latest release](https://github.com/verus-lang/verusfmt/releases/latest) using:

- <details><summary>Pre-built binary on Linux/MacOS (click to expand)</summary>
- Pre-built binaries (recommended)

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/verus-lang/verusfmt/releases/latest/download/verusfmt-installer.sh | sh
```
</details>
+ <details><summary>Pre-built binary on Linux/MacOS (click to expand)</summary>

- <details><summary>Pre-built binary on Windows (click to expand)</summary>
```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/verus-lang/verusfmt/releases/latest/download/verusfmt-installer.sh | sh
```
</details>

```sh
irm https://github.com/verus-lang/verusfmt/releases/latest/download/verusfmt-installer.ps1 | iex
```
</details>
+ <details><summary>Pre-built binary on Windows (click to expand)</summary>

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

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

Expand All @@ -41,15 +38,6 @@ We support multiple install methods:
```
</details>

* Bleeding-edge latest git commit

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

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


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

``` sh
Expand Down

0 comments on commit dd20acc

Please sign in to comment.