Skip to content

Commit

Permalink
docs(readme): add "build from source" section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Sep 27, 2021
1 parent e444615 commit b193f42
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit b193f42

Please sign in to comment.