diff --git a/README.md b/README.md index a924e7f1..dc93b636 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,54 @@ curl -fsSL https://christitus.com/linux | sh ```bash curl -fsSL https://christitus.com/linuxdev | sh ``` +## ⬇️ Installation + +Linutil is also available as a package in various repositories: + +[![Packaging status](https://repology.org/badge/vertical-allrepos/linutil.svg)](https://repology.org/project/linutil/versions) + +
+ Arch Linux + +Linutil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages: + +- `linutil` - Stable release compiled from source +- `linutil-bin` - Stable release pre-compiled +- `linutil-git` - Compiled from the last commit (not recommended) + +by running: + +```bash +git clone https://aur.archlinux.org/.git +cd linutil +makepkg -si +``` + +Replace `` with your preferred package. + +If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simplier: + +```bash +paru -S linutil +``` + +Replace `paru` with your preferred helper and `linutil` with your preferred package. + +
+ +
+ Cargo + +Linutil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with: + +```bash +cargo install linutil +``` + +Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup)) + +
+ ## 💖 Support If you find Linutil helpful, please consider giving it a ⭐️ to show your support! diff --git a/docs/index.md b/docs/index.md index d947deed..0796d4cf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,10 @@ # Welcome to the LinUtil Documentation! [![Version](https://img.shields.io/github/v/release/ChrisTitusTech/linutil?color=%230567ff&label=Latest%20Release&style=for-the-badge)](https://github.com/ChrisTitusTech/linutil/releases/latest) -![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/start.sh?label=Total%20Downloads&style=for-the-badge) -[![Discord Community Server](https://dcbadge.limes.pink/api/server/https://discord.gg/bujFYKAHSp)](https://discord.gg/bujFYKAHSp) +![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/linutil?label=Total%20Downloads&style=for-the-badge) +[![](https://dcbadge.limes.pink/api/server/https://discord.gg/bujFYKAHSp)](https://discord.gg/bujFYKAHSp) + +[![Crates.io Version](https://img.shields.io/crates/v/linutil_tui?style=for-the-badge&color=%23af3a03)](https://crates.io/crates/linutil_tui) [![linutil AUR Version](https://img.shields.io/aur/version/linutil?style=for-the-badge&label=%5BAUR%5D%20linutil&color=%23230567ff)](https://aur.archlinux.org/packages/linutil) [![linutil-bin AUR Version](https://img.shields.io/aur/version/linutil-bin?style=for-the-badge&label=%5BAUR%5D%20linutil-bin&color=%23230567ff)](https://aur.archlinux.org/packages/linutil-bin) ## Running the latest release of LinUtil @@ -15,6 +17,56 @@ curl -fsSL https://christitus.com/linux | sh ``` --- +### Installation + +LinUtil is also available as a package in various repositories: + +[![Packaging status](https://repology.org/badge/vertical-allrepos/linutil.svg)](https://repology.org/project/linutil/versions) + +
+ Arch Linux + +LinUtil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages: + +- `linutil` - Stable release compiled from source +- `linutil-bin` - Stable release pre-compiled +- `linutil-git` - Compiled from the last commit (not recommended) + +by running: + +```bash +git clone https://aur.archlinux.org/.git +cd linutil +makepkg -si +``` + +Replace `` with your preferred package. + +If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler: + +```bash +paru -S linutil +``` + +Replace `paru` with your preferred helper and `linutil` with your preferred package. + +
+ +
+ Cargo + +LinUtil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with: + +```bash +cargo install linutil +``` + +Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup)) + +
+ +--- + After you've ran the command, you should see a GUI on your screen; It will look something like this: ![preview](assets/preview.png)