// SPDX-FileCopyrightText: 2022 Shun Sakai
//
// SPDX-License-Identifier: GPL-3.0-or-later
= How to Build
:cargo: https://doc.rust-lang.org/stable/cargo/[Cargo]
:asciidoctor-org: https://asciidoctor.org/[Asciidoctor]
== Prerequisites
.To build *abcrypt*, you will need the following dependencies
* {cargo} (v1.65.0 or later)
.To build man pages, you will need the following additional dependencies
* {asciidoctor-org}
== Building from source
.To clone the repository
[source,shell]
----
git clone https://github.com/sorairolake/abcrypt.git
cd abcrypt
----
.To build a package
[source,shell]
----
just build
----
== Crate features
`json`::
Enable outputting the encryption parameters as JSON. This is enabled by
default.