From 73b4a8d08dfea0226a803d3b55cfce9f37d021e6 Mon Sep 17 00:00:00 2001 From: obvMellow Date: Fri, 9 Aug 2024 23:50:32 +0300 Subject: [PATCH] Update README.md --- README.md | 45 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 36 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 119449c..fc90ed9 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,38 @@ Simple backup tool written in Rust # Installation -## Linux +## Prebuilt Binary -### Arch Linux +Install the latest binary from [Releases](https://github.com/obvMellow/hardcpy/releases) -On Arch Linux you can simply install it from the AUR +### AUR + +On Arch Linux you can install the pre-built binary from the AUR ```sh -git clone https://aur.archlinux.org/hardcpy-git.git -cd hardcpy-git +git clone https://aur.archlinux.org/hardcpy-bin.git +cd hardcpy-bin makepkg -si +pacman -U hardcpy-bin-{Insert Version}-x86_64.pkg.tar.zst ``` Or you can use a wrapper such as [yay](https://github.com/Jguer/yay) ```sh -yay -S hardcpy-git +yay -S hardcpy-bin ``` -### Other distributions +## Compiling From Source -You can install it using cargo +### AUR + +Run the following commands +```sh +git clone https://aur.archlinux.org/hardcpy-git.git +cd hardcpy-git +makepkg -si +pacman -U hardcpy-git-{Insert Version}-x86_64.pkg.tar.zst +``` + +### Other distributions / Windows Make sure you have [cargo](https://www.rust-lang.org/tools/install) installed @@ -34,7 +47,21 @@ $ cargo --version cargo 1.80.0 (376290515 2024-07-16) ``` -Then you can simply install it with the following command +Clone the repo and build the project +```sh +git clone https://github.com/obvMellow/hardcpy.git +cd hardcpy +cargo build --release +``` + +### Using Cargo + +You can simply install it with the following command ```sh cargo install hardcpy ``` + +And make sure you have ~/.cargo/bin in your $PATH +```sh +export PATH=$HOME/.cargo/bin:$PATH +```