Add table of package managers that include just to readme (#568)

This commit is contained in:
Casey Rodarmor 2019-12-20 04:22:37 -08:00 committed by GitHub
parent b8d6fc6681
commit eeb603160a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -46,6 +46,8 @@ toc::[]
== Installation
=== Prerequisites
`just` should run on any system with a reasonable `sh`, including Linux, MacOS, and the BSDs.
On Windows, `just` works with the `sh` provided by https://git-scm.com[Git for Windows], https://desktop.github.com[GitHub Desktop], and http://www.cygwin.com[Cygwin].
@ -74,6 +76,29 @@ hello:
Write-Host "Hello, world!"
```
=== Packages
[options="header"]
|===============================================================================================================================================================
| Operating System | Package Manager | Package | Command
| https://forge.rust-lang.org/release/platform-support.html[Various] | https://www.rust-lang.org[Cargo] | https://crates.io/crates/just[just] | `cargo install just`
| https://en.wikipedia.org/wiki/Microsoft_Windows[Microsoft Windows] | https://scoop.sh[Scoop] | https://github.com/ScoopInstaller/Main/blob/master/bucket/just.json[just] | `scoop install just`
| https://en.wikipedia.org/wiki/MacOS[macOS] | https://brew.sh[Homebrew] | https://formulae.brew.sh/formula/just[just] | `brew install just`
| https://en.wikipedia.org/wiki/MacOS[macOS] | https://www.macports.org[MacPorts] | https://ports.macports.org/port/just/summary[just] | `port install just`
| https://www.archlinux.org[Arch Linux] | https://github.com/Jguer/yay[Yay] | https://aur.archlinux.org/packages/just/[just] ^AUR^ | `yay -S just`
| https://nixos.org/nixos/[NixOS], https://nixos.org/nix/manual/#ch-supported-platforms[Linux], https://nixos.org/nix/manual/#ch-supported-platforms[macOS] | https://nixos.org/nix/[Nix] | https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/just/default.nix[just] | `nix-env -iA nixos.just`
| https://voidlinux.org[Void Linux] | https://wiki.voidlinux.org/XBPS[XBPS] | https://github.com/void-linux/void-packages/blob/master/srcpkgs/just/template[just] | `xbps-install -S just`
|===============================================================================================================================================================
=== Pre-built Binaries
Pre-built binaries for Linux, MacOS, and Windows can be found on https://github.com/casey/just/releases[the releases page].
@ -92,48 +117,6 @@ curl -LSfs https://japaric.github.io/trust/install.sh | \
sh -s -- --git casey/just --target x86_64-unknown-linux-musl --to DESTINATION_DIRECTORY
```
=== Homebrew
On MacOS, `just` can be installed using the https://brew.sh[Homebrew package manager]. Install Homebrew using the instructions https://brew.sh[here], then run:
`brew install just`
=== Scoop
On Windows, `just` can be installed using the https://scoop.sh[Scoop package manager]. Install Scoop using the instructions https://scoop.sh/[here], then run:
```powershell
scoop install just
```
=== Arch Linux
On Arch Linux, `just` is packaged as https://aur.archlinux.org/packages/just/[just] in AUR, the https://aur.archlinux.org[Arch User Repository]. Several tools are available to install packages from AUR, including https://github.com/Jguer/yay[yay].
=== Void Linux
On Void Linux, `just` can be installed with:
```sh
sudo xbps-install -S just
```
=== Nix
On NixOS, Linux, and MacOS, `just` can be installed using the https://nixos.org/nix/[Nix package manager]. Install https://nixos.org/nix/download.html[Nix] or https://nixos.org/nixos/download.html[NixOS], then run:
```sh
nix-env -i just
```
=== Cargo
On Windows, Linux, and macOS, `just` can be installed using Cargo, the https://www.rust-lang.org[rust language package manager]. Install Cargo using the instructions https://www.rustup.rs[here], then run:
`cargo install just`
(You might also need to add `~/.cargo/bin` to your shell's `$PATH`. If you can't run just after installing it, put `export PATH="$HOME/.cargo/bin:$PATH"` in your shell's configuration file.)
== Quick Start