james/age-plugin-yubikey
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #138 from str4d/refactor-installation-docs

Browse Source 
Refactor installation docs
This commit is contained in:
str4d
2023-03-23 09:19:31 +00:00
committed by GitHub
parent 95657fd844 b6030ec4bd
commit 22fd00bd22
1 changed files with 16 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -37
View File
@@ -6,55 +6,34 @@ which enables files to be encrypted to age identities stored on YubiKeys.
## Installation ## 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 On Windows, Linux, and macOS, you can use the
[pre-built binaries](https://github.com/str4d/age-plugin-yubikey/releases). [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. Help from new packagers is very welcome.
### macOS
You can install using Homebrew:
```
brew install age-plugin-yubikey
```
### Linux, BSD, etc. ### Linux, BSD, etc.
On non-Windows, non-macOS systems, you need to ensure that the `pcscd` service On non-Windows, non-macOS systems, you need to ensure that the `pcscd` service
is installed and running. is installed and running.
#### Debian or Ubuntu | Environment | CLI command |
|-------------|-------------|
| Debian or Ubuntu | `sudo apt-get install pcscd` |
| OpenBSD | As ```root``` do:<br>`pkg_add pcsc-lite ccid`<br>`rcctl enable pcscd`<br>`rcctl start pcscd` |
| FreeBSD | As ```root``` do:<br>`pkg install pcsc-lite libccid`<br>`service pcscd enable`<br>`service pcscd start` |
``` When installing via Cargo, you also need to ensure that the development headers
$ sudo apt-get install pcscd for the `pcsc-lite` library are available, so that the `pcsc-sys` crate can be
``` compiled.
#### OpenBSD | Environment | CLI command |
|-------------|-------------|
As ```root``` do: | Debian or Ubuntu | `sudo apt-get install libpcsclite-dev` |
```
$ 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) ### Windows Subsystem for Linux (WSL)