Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document MSRV and build dependencies #88

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document MSRV and build dependencies #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6eb5ff4
Document MSRV policy
robin-nitrokey Oct 23, 2022
4ce0ca6
Document build dependencies
robin-nitrokey Oct 23, 2022
74d76d7
Fix rust toolchain version and review comments
sosthene-nitrokey May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ edition = "2021"
description = "OpenPGP smart card implementation"
repository = "https://github.com/nitrokey/opcard-rs"
license = "LGPL-3.0-only"
rust-version = "1.66.0" # see MSRV section in readme

[workspace]
members = [
Expand Down
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,29 @@ 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
sosthene-nitrokey marked this conversation as resolved.
Show resolved Hide resolved
- Rust toolchain

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 development environment on Debian-based distributions.

For a complete usb token firmware implementation including Opcard for OpenPGP support, see the [Nitrokey 3 firmware repository](https://github.com/Nitrokey/nitrokey-3-firmware).

## Minimum Supported Rust Version (MSRV)

The minimum supported Rust version (MSRV) for this crate is the most recent stable Rust release.
Older versions may or may not work.
Rust versions older than 1.66.0 cannot be used to build this crate.

## Bug reports

Expand Down