docs(install): Improve Installation docs

* Introduce OS sections
* Introduce general intro text
* Highlight differentiators (OS and package managers)
* Use consistent source code spacing
pull/780/head
Jan Klass 2024-10-26 12:30:44 +07:00 committed by Wilfred Hughes
parent c2e98bb65a
commit 0b3b187d02
1 changed files with 24 additions and 10 deletions

@ -1,17 +1,26 @@
# Installation # Installation
Difftastic [provides GitHub Diffstatic can be installed as pre-built binaries or using various package managers.
releases](https://github.com/Wilfred/difftastic/releases) with
prebuilt binaries for Windows, macOS and Linux.
If you're a Homebrew user, you can install ## Pre-Built Binaries
Diffstatic releases are published as [GitHub releases](https://github.com/Wilfred/difftastic/releases) with pre-built binaries for Windows, macOS and Linux.
The [latest release page](https://github.com/Wilfred/difftastic/releases/latest) should have what you are looking for.
## Package Manager
### macOS
If you're a **Homebrew** user, you can install
[difftastic](https://formulae.brew.sh/formula/difftastic) with `brew`. [difftastic](https://formulae.brew.sh/formula/difftastic) with `brew`.
``` ```
$ brew install difftastic $ brew install difftastic
``` ```
If you're an Arch Linux user, you can install ### Linux and Unix
If you're an **Arch Linux** user, you can install
[difftastic](https://archlinux.org/packages/extra/x86_64/difftastic/) [difftastic](https://archlinux.org/packages/extra/x86_64/difftastic/)
with `pacman`. with `pacman`.
@ -19,7 +28,7 @@ with `pacman`.
$ sudo pacman -S difftastic $ sudo pacman -S difftastic
``` ```
If you're a Nix user, you can install If you're a **Nix** user, you can install
[difftastic](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/text/difftastic/default.nix) [difftastic](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/text/difftastic/default.nix)
with `nix-env`. with `nix-env`.
@ -27,29 +36,34 @@ with `nix-env`.
$ nix-env --install difftastic $ nix-env --install difftastic
``` ```
If you're a Fedora user, you can install [difftastic](https://packages.fedoraproject.org/pkgs/rust-difftastic/difftastic/) with `dnf`. If you're a **Fedora** user, you can install [difftastic](https://packages.fedoraproject.org/pkgs/rust-difftastic/difftastic/) with `dnf`.
``` ```
$ sudo dnf install difftastic $ sudo dnf install difftastic
``` ```
If you're a FreeBSD user, you can install If you're a **FreeBSD** user, you can install
[difftastic](https://www.freshports.org/textproc/difftastic/) [difftastic](https://www.freshports.org/textproc/difftastic/)
with `pkg`. with `pkg`.
``` ```
$ sudo pkg install difftastic $ sudo pkg install difftastic
``` ```
If you're a Windows user, you can install ### Windows
If you're a Windows user using **Scoop**, you can install
[difftastic](https://scoop.sh/#/apps?q=difftastic) [difftastic](https://scoop.sh/#/apps?q=difftastic)
with `scoop`. with `scoop`.
``` ```
$ scoop install difftastic $ scoop install difftastic
``` ```
If you're a Windows user, you can install If you're a Windows user using **Chocolatey**, you can install
[difftastic](https://community.chocolatey.org/packages/difftastic) [difftastic](https://community.chocolatey.org/packages/difftastic)
with `choco`. with `choco`.
``` ```
$ choco install difftastic $ choco install difftastic
``` ```