Update installation instructions
This patch updates the installation instructions with information on the AUR packgage and on the tarball downloads.
This commit is contained in:
parent
28c025fd4f
commit
3affe94234
50
INSTALL.md
50
INSTALL.md
@ -5,11 +5,20 @@ SPDX-License-Identifier: MIT
|
|||||||
|
|
||||||
# Installing rusty-man
|
# Installing rusty-man
|
||||||
|
|
||||||
## Requirements
|
## Installing a package
|
||||||
|
|
||||||
|
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.
|
To compile rusty-man, you need Rust 1.40 or later.
|
||||||
|
|
||||||
## Installing from source
|
### Installing from Git
|
||||||
|
|
||||||
1. Clone the rusty-man Git repository:
|
1. Clone the rusty-man Git repository:
|
||||||
```
|
```
|
||||||
@ -22,18 +31,49 @@ To compile rusty-man, you need Rust 1.40 or later.
|
|||||||
3. Optional: Verify the signature of the latest commit:
|
3. Optional: Verify the signature of the latest commit:
|
||||||
```
|
```
|
||||||
$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
|
$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
|
||||||
$ gpg verify-commit HEAD
|
$ git verify-commit HEAD
|
||||||
```
|
```
|
||||||
4. Compile rusty-man:
|
4. Compile rusty-man:
|
||||||
```
|
```
|
||||||
$ cargo build --release
|
$ cargo build --release --locked
|
||||||
```
|
```
|
||||||
5. Optional: Install the rusty-man binary:
|
5. Optional: Install the rusty-man binary:
|
||||||
```
|
```
|
||||||
$ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man
|
$ 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
|
cargo install rusty-man
|
||||||
|
@ -55,8 +55,10 @@ For more usage information, run `rusty-man --help`.
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
To install rusty-man, clone this repository and use cargo to build the project,
|
To install rusty-man from source, clone this repository and use cargo to build
|
||||||
or use `cargo install`. See the [`INSTALL.md`][] file for more information.
|
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
|
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
|
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
|
[issue tracker]: https://todo.sr.ht/~ireas/rusty-man
|
||||||
[MIT license]: https://opensource.org/licenses/MIT
|
[MIT license]: https://opensource.org/licenses/MIT
|
||||||
[reuse]: https://reuse.software/practices/3.0/
|
[reuse]: https://reuse.software/practices/3.0/
|
||||||
|
|
||||||
|
[pkg-aur]: https://aur.archlinux.org/packages/rusty-man/
|
||||||
|
Loading…
Reference in New Issue
Block a user