Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates #80

Merged
merged 1 commit into from
Jul 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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