rusty-man/INSTALL.md
Robin Krahl 4d7c7d4eab
Release v0.1.2
This patch release adds basic logging output and a new `-e`/`--examples`
option to extract only the examples from the documentation.  It also
fixes a bug when displaying the documentation for a function.
2020-07-25 13:29:14 +02:00

849 B

Installing rusty-man

Requirements

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: Checkout the latest release:
    $ git checkout v0.1.2
    
  3. Optional: Verify the signature of the latest commit:
    $ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
    $ gpg verify-commit HEAD
    
  4. Compile rusty-man:
    $ cargo build --release
    
  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