Skip to content

Commit

Permalink
Document build dependencies
Browse files Browse the repository at this point in the history
This patch adds a section with the build dependencies to the readme.
  • Loading branch information
robin-nitrokey authored and sosthene-nitrokey committed May 24, 2023
1 parent 6eb5ff4 commit 4ce0ca6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,21 @@ Download the latest compiled [alpha release](https://github.com/Nitrokey/nitroke
Plug your Nitrokey 3 and use [nitropy](https://docs.nitrokey.com/software/nitropy/) to install it with
`nitropy nk3 update <path/to/release/file>`

## Build Dependencies

`opcard` has these build dependencies:
- clang
- libpcsclite
- nettle
- pkg-config

To run the tests, you also need these tools:
- gnupg
- scdaemon
- vsmartcard (vpcd)

See the [CI Dockerfile](./ci/Dockerfile) for all steps to set up the build environment on Debian-based distributions.

## Minimum Supported Rust Version (MSRV)

The minimum supported Rust version (MSRV) for this crate is the most recent stable Rust release.
Expand Down

0 comments on commit 4ce0ca6

Please sign in to comment.