From 5a93c638d39f7be5cbb216811600975d1daf3bf6 Mon Sep 17 00:00:00 2001
From: nolim1t <hello@nolim1t.co>
Date: Sun, 30 Aug 2020 14:42:19 +0700
Subject: [PATCH] Add udev rules

---
 udevrules.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 udevrules.md

diff --git a/udevrules.md b/udevrules.md
new file mode 100644
index 0000000..e7f4a05
--- /dev/null
+++ b/udevrules.md
@@ -0,0 +1,25 @@
+# udev rules
+
+This directory contains all of the udev rules for the supported devices as retrieved from vendor websites and repositories.
+These are necessary for the devices to be reachable on linux environments.
+
+- `20-hw1.rules` (Ledger): https://github.com/LedgerHQ/udev-rules/blob/master/20-hw1.rules
+- `51-coinkite.rules` (Coldcard): https://github.com/Coldcard/ckcc-protocol/blob/master/51-coinkite.rules
+- `51-hid-digitalbitbox.rules`, `52-hid-digitalbitbox.rules` (Digital Bitbox): https://shiftcrypto.ch/start_linux
+- `51-trezor.rules` (Trezor): https://github.com/trezor/trezor-common/blob/master/udev/51-trezor.rules
+- `51-usb-keepkey.rules` (Keepkey): https://github.com/keepkey/udev-rules/blob/master/51-usb-keepkey.rules
+
+# Usage
+
+Apply these rules by copying them to `/etc/udev/rules.d/` and notifying `udevadm`.
+Your user will need to be added to the `plugdev` group, which needs to be created if it does not already exist.
+
+```
+$ cd hwilib/
+$ sudo cp udev/*.rules /etc/udev/rules.d/
+$ sudo udevadm trigger
+$ sudo udevadm control --reload-rules
+$ sudo groupadd plugdev
+$ sudo usermod -aG plugdev `whoami`
+```
+