From 9730e3da74808718816fdb2dc22b49918eefaf3a Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Thu, 23 Mar 2023 17:38:17 +0900 Subject: [PATCH 1/2] Clean up "Installation" readme section with tables --- README.md | 49 ++++++++++--------------------------------------- 1 file changed, 10 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 3dd29a0..c48a7a1 100644 --- a/README.md +++ b/README.md @@ -6,55 +6,26 @@ which enables files to be encrypted to age identities stored on YubiKeys. ## Installation +| Environment | CLI command | +|-------------|-------------| +| Cargo (Rust 1.65+) | `cargo install age-plugin-yubikey` | +| Homebrew (macOS or Linux) | `brew install age-plugin-yubikey` | + On Windows, Linux, and macOS, you can use the [pre-built binaries](https://github.com/str4d/age-plugin-yubikey/releases). -If your system has Rust 1.65+ installed (either via `rustup` or a system -package), you can build directly from source: - -``` -cargo install age-plugin-yubikey -``` - Help from new packagers is very welcome. -### macOS - -You can install using Homebrew: - -``` -brew install age-plugin-yubikey -``` - ### Linux, BSD, etc. On non-Windows, non-macOS systems, you need to ensure that the `pcscd` service is installed and running. -#### Debian or Ubuntu - -``` -$ sudo apt-get install pcscd -``` - -#### OpenBSD - -As ```root``` do: - -``` -$ pkg_add pcsc-lite ccid -$ rcctl enable pcscd -$ rcctl start pcscd -``` - -#### FreeBSD - -As ```root``` do: -``` -$ pkg install pcsc-lite libccid -$ service pcscd enable -$ service pcscd start -``` +| Environment | CLI command | +|-------------|-------------| +| Debian or Ubuntu | `sudo apt-get install pcscd` | +| OpenBSD | As ```root``` do:
`pkg_add pcsc-lite ccid`
`rcctl enable pcscd`
`rcctl start pcscd` | +| FreeBSD | As ```root``` do:
`pkg install pcsc-lite libccid`
`service pcscd enable`
`service pcscd start` | ### Windows Subsystem for Linux (WSL) From b6030ec4bd6db4b3eeb0d4b53d29bd3b5ca7a490 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Thu, 23 Mar 2023 17:43:26 +0900 Subject: [PATCH 2/2] Note `libpcsclite-dev` dependency for Cargo builds in readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c48a7a1..0632083 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,14 @@ is installed and running. | OpenBSD | As ```root``` do:
`pkg_add pcsc-lite ccid`
`rcctl enable pcscd`
`rcctl start pcscd` | | FreeBSD | As ```root``` do:
`pkg install pcsc-lite libccid`
`service pcscd enable`
`service pcscd start` | +When installing via Cargo, you also need to ensure that the development headers +for the `pcsc-lite` library are available, so that the `pcsc-sys` crate can be +compiled. + +| Environment | CLI command | +|-------------|-------------| +| Debian or Ubuntu | `sudo apt-get install libpcsclite-dev` | + ### Windows Subsystem for Linux (WSL) WSL does not currently provide native support for USB devices. However, Windows