blob42/rusty-man
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update installation instructions

Browse Source 
This patch adds information about installing from crates.io and suggests
checking out the latest release when installing from source.
This commit is contained in:
Robin Krahl 2020-07-24 13:45:23 +02:00
parent afe3b02a34
commit 0a1dd0838e
No known key found for this signature in database
GPG Key ID: 8E9B0870524F69D8
2 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
INSTALL.md
View File

@ -5,24 +5,36 @@ SPDX-License-Identifier: MIT
# Installing rusty-man
## Installing from source
## Requirements
To install rusty-man from source, you need Rust 1.40 or later.
To compile rusty-man, you need Rust 1.40 or later.
## Installing from source
1. Clone the rusty-man Git repository:
```
$ git clone https://git.sr.ht/~ireas/rusty-man && cd rusty-man
```
2. Optional: Verify the signature of the latest commit:
2. Optional: Checkout the latest release:
```
$ git checkout v0.1.0
```
3. Optional: Verify the signature of the latest commit:
```
$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
$ gpg verify-commit HEAD
```
3. Compile rusty-man:
4. Compile rusty-man:
```
$ cargo build --release
```
4. Optional: Install the rusty-man binary:
5. Optional: Install the rusty-man binary:
```
$ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man
```
## Installing from crates.io
```
cargo install rusty-man
```

5
README.md
View File

@ -54,8 +54,9 @@ For more usage information, run `rusty-man --help`.
## Installation
To install rusty-man, clone this repository and use cargo to build the project.
See the [`INSTALL.md`](./INSTALL.md) file for more information.
To install rusty-man, clone this repository and use cargo to build the project,
or use `cargo install`. See the [`INSTALL.md`](./INSTALL.md) file for more
information.
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