From 3affe94234ff060fc540a764c95d832505ba3fdc Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Tue, 11 Aug 2020 09:59:43 +0200 Subject: [PATCH] Update installation instructions This patch updates the installation instructions with information on the AUR packgage and on the tarball downloads. --- INSTALL.md | 50 +++++++++++++++++++++++++++++++++++++++++++++----- README.md | 8 ++++++-- 2 files changed, 51 insertions(+), 7 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 0aaf705..0ec3c6d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -5,12 +5,21 @@ SPDX-License-Identifier: MIT # Installing rusty-man -## Requirements +## Installing a package -To compile rusty-man, you need Rust 1.40 or later. +rusty-man packages are available for these distributions: +- Arch Linux: [`rusty-man`][pkg-aur] in the Arch User Repository + +[pkg-aur]: https://aur.archlinux.org/packages/rusty-man/ ## Installing from source +### Build Requirements + +To compile rusty-man, you need Rust 1.40 or later. + +### Installing from Git + 1. Clone the rusty-man Git repository: ``` $ git clone https://git.sr.ht/~ireas/rusty-man && cd rusty-man @@ -22,18 +31,49 @@ To compile rusty-man, you need Rust 1.40 or later. 3. Optional: Verify the signature of the latest commit: ``` $ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import - $ gpg verify-commit HEAD + $ git verify-commit HEAD ``` 4. Compile rusty-man: ``` - $ cargo build --release + $ cargo build --release --locked ``` 5. Optional: Install the rusty-man binary: ``` $ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man ``` -## Installing from crates.io +### Installing from a tarball + +1. Download the tarball for the latest rusty-man release (see the [release + list][]) and optionally its signature: + ``` + $ curl "https://git.sr.ht/~ireas/rusty-man/archive/v0.1.3.tar.gz" \ + --output rusty-man-v0.1.3.tar.gz + ``` +2. Optional: Download and verify the signature of the tarball: + ``` + $ curl "https://git.sr.ht/~ireas/rusty-man/refs/v0.1.3/v0.1.3.tar.gz.asc" \ + --output rusty-man-v0.1.3.tar.gz.asc + $ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import + $ gpg --verify rusty-man-v0.1.3.tar.gz.asc + ``` +3. Extract the tarball: + ``` + $ tar -xf rusty-man-v0.1.3.tar.gz + $ cd rusty-man-v0.1.3 + ``` +4. Compile rusty-man: + ``` + $ cargo build --release --locked + ``` +5. Optional: Install the rusty-man binary: + ``` + $ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man + ``` + +[release list]: https://git.sr.ht/~ireas/rusty-man/refs + +### Installing from crates.io ``` cargo install rusty-man diff --git a/README.md b/README.md index 5dd71b1..9a6849c 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,10 @@ For more usage information, run `rusty-man --help`. ## Installation -To install rusty-man, clone this repository and use cargo to build the project, -or use `cargo install`. See the [`INSTALL.md`][] file for more information. +To install rusty-man from source, clone this repository and use cargo to build +the project, or use `cargo install`. See the [`INSTALL.md`][] file for more +information. rusty-man is also available as a package for these distributions: +- Arch Linux: [`rusty-man`][pkg-aur] in the Arch User Repository rusty-man should run on all platforms supported by [`crossterm`][]. If you have trouble running rusty-man on your platform or if you want to help porting @@ -107,3 +109,5 @@ This project is licensed under the [MIT License][]. [issue tracker]: https://todo.sr.ht/~ireas/rusty-man [MIT license]: https://opensource.org/licenses/MIT [reuse]: https://reuse.software/practices/3.0/ + +[pkg-aur]: https://aur.archlinux.org/packages/rusty-man/