diff --git a/README.md b/README.md index db21d67b5d..c9d53a1536 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,8 @@ - [Installation](#installation) - [From crates.io](#from-cratesio) - [Using pacman](#using-pacman) - - [Binary Releases](#binary-releases) + - [Binary releases](#binary-releases) + - [Build from source](#build-from-source) - [Usage](#usage) - [Command Line Arguments](#command-line-arguments) - [Examples](#examples) @@ -104,12 +105,21 @@ If you are using Arch Linux, **git-cliff** can be installed from the [community pacman -S git-cliff ``` -### Binary Releases +### Binary releases See the available binaries for different operating systems/architectures from the [releases page](https://github.com/orhun/git-cliff/releases). \* Release tarballs are signed with the following PGP key: [1D2D410A741137EBC544826F4A92FA17B6619297](https://keyserver.ubuntu.com/pks/lookup?search=0x4A92FA17B6619297&op=vindex) +### Build from source + +* Linux dependencies: [zlib](https://zlib.net/) + +```sh +# binary will be located at `target/release/git-cliff` +CARGO_TARGET_DIR=target cargo build --release +``` + ## Usage ### Command Line Arguments