From f82cc6ae2ad23d21ed935474121f205284c923ec Mon Sep 17 00:00:00 2001 From: Heiko Schaefer Date: Fri, 5 Nov 2021 22:57:10 +0100 Subject: [PATCH] Add documentation on installing. --- tools/README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/tools/README.md b/tools/README.md index f22582a..0702760 100644 --- a/tools/README.md +++ b/tools/README.md @@ -6,9 +6,30 @@ SPDX-License-Identifier: MIT OR Apache-2.0 # OpenPGP card tools This crate contains two tools for inspecting, configuring and using OpenPGP -cards: +cards: `opgpcard` and `opgpcard-pin`. + +# Install + +One easy way to install this crate is via the "cargo" tool. + +The following build dependencies are needed for current Debian: + +``` +# apt install rustc cargo clang pkg-config nettle-dev libpcsclite-dev +``` + +And for current Fedora: + +``` +# dnf install rustc cargo clang nettle-devel pcsc-lite-devel +``` + +Afterwards, you can install this crate by running: + +``` +$ cargo install openpgp-card-tools +``` -`opgpcard` and `opgpcard-pin` ## opgpcard