From c0f60da9e6080c6f6fbcfbdf5bdee8a7747a6bbc Mon Sep 17 00:00:00 2001 From: William Woodruff Date: Mon, 2 Dec 2024 11:31:47 -0500 Subject: [PATCH] docs: tweak installation layout (#223) --- docs/installation.md | 52 +++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 15 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 9eb73bc6..d417ee45 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,30 +4,52 @@ description: Installation instructions for zizmor. # Installation -## From crates.io +## From package managers -You can install `zizmor` from with `cargo`: +`zizmor` is available within several packaging ecosystems. -```bash -cargo install zizmor -``` +=== "crates.io" -## From Homebrew + You can install `zizmor` from with `cargo`: -`zizmor` is provided by [Homebrew](https://brew.sh/) as well: + ```bash + cargo install zizmor + ``` -```bash -brew install zizmor -``` +=== "Homebrew" + + `zizmor` is provided by [Homebrew](https://brew.sh/): + + ```bash + brew install zizmor + ``` + +=== "Nix" + + !!! note + + This is a community-maintained package. + + ```bash + # without flakes + nix-env -iA nixos.zizmor + + # with flakes + nix profile install nixpkgs#zizmor + ``` + +=== "Other ecosystems" + + !!! info + + Are you interested in packaging `zizmor` for another ecosystem? + Let us know by [filing an issue](https://github.com/woodruffw/zizmor/issues/new)! -## Other package managers + The badge below tracks `zizmor`'s overall packaging status. -!!! info + [![Packaging status](https://repology.org/badge/vertical-allrepos/zizmor.svg)](https://repology.org/project/zizmor/versions) - Are you interested in packaging `zizmor` for another ecosystem? - Let us know by [filing an issue](https://github.com/woodruffw/zizmor/issues/new)! -[![Packaging status](https://repology.org/badge/vertical-allrepos/zizmor.svg)](https://repology.org/project/zizmor/versions) ## From source