From 51c0c1468a8b16efbd854aeadbc21b3651f739b0 Mon Sep 17 00:00:00 2001 From: Jay Bosamiya Date: Fri, 5 Jul 2024 15:27:56 -0700 Subject: [PATCH] README improvements - Remove old warning, now that verusfmt is successfully being used (and also under CI) for multiple projects - Explicitly recommend pre-built binaries --- README.md | 32 +++++++++----------------------- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c23d772..d49fc80 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) - -
Pre-built binary on Linux/MacOS (click to expand) + +
Linux/MacOS (click to expand) ```sh curl --proto '=https' --tlsv1.2 -LsSf https://github.com/verus-lang/verusfmt/releases/latest/download/verusfmt-installer.sh | sh ```
- -
Pre-built binary on Windows (click to expand) + +
Windows (click to expand) ```sh irm https://github.com/verus-lang/verusfmt/releases/latest/download/verusfmt-installer.ps1 | iex ```
- -
cargo install (click to expand) - - ``` sh - cargo install verusfmt --locked - ``` -
- -* Bleeding-edge latest git commit - - -
cargo install (click to expand) - - ```sh - cargo install --git https://github.com/verus-lang/verusfmt --locked - ``` +-
cargo install (click to expand) + ``` sh + cargo install verusfmt --locked + ``` +
These will install the `verusfmt` binary. You can then run it on a file using: