Skip to content

Commit

Permalink
README updates (#80)
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, I don't think that the strong
warning up-front is warranted anymore
- Explicitly recommend pre-built binaries which are faster to get,
support easy updating, etc.
- Remove the instructions for "bleeding-edge" since our release cadence
is best suited to folks actually picking up releases. If we need someone
to test a specific branch, we can just direct them to try that branch
directly instead, but for the most part, I don't think it makes sense
for folks to pull from `main` directly anymore.
  • Loading branch information
jaybosamiya-ms authored Jul 8, 2024
1 parent 6183c44 commit 5e1dc17
Showing 1 changed file with 9 additions and 23 deletions.
32 changes: 9 additions & 23 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 @@ -16,39 +11,30 @@ verusfmt --update

## Installing and Using Verusfmt

We support multiple install methods:
We support multiple install methods. Get the [latest release](https://github.com/verus-lang/verusfmt/releases/latest) using:

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

- <details><summary>Pre-built binary on Linux/MacOS (click to expand)</summary>
+ <details><summary>Linux/MacOS (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>

- <details><summary>Pre-built binary on Windows (click to expand)</summary>
+ <details><summary>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>

``` 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/verus-lang/verusfmt --locked
```
- <details><summary>cargo install (click to expand)</summary>

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

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

Expand Down

0 comments on commit 5e1dc17

Please sign in to comment.