From 09bdfb39c26172d1fa4b971edff9702955cf84f5 Mon Sep 17 00:00:00 2001 From: Jay Bosamiya Date: Mon, 12 Feb 2024 22:19:33 -0500 Subject: [PATCH] Improve installation instructions --- README.md | 40 +++++++++++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 31e7027..b7b1a0a 100644 --- a/README.md +++ b/README.md @@ -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: + -
Pre-built binary on Linux/MacOS (click to expand) + + ```sh + curl --proto '=https' --tlsv1.2 -LsSf https://github.com/jaybosamiya/verusfmt/releases/latest/download/verusfmt-installer.sh | sh + ``` +
+ + -
Pre-built binary on Windows (click to expand) + + ```sh + irm https://github.com/jaybosamiya/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/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