Skip to content

Commit ca974c2

Browse files
coffandroclaude
andcommitted
Update docs and CI workflow
- Make kernel module fix instructions universal for all Linux distros - Add Raspberry Pi OS to Debian section - Move atomic distro note below Fedora - CI workflow now ignores .md and LICENSE changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 394f92d commit ca974c2

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

.github/workflows/ci.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@ name: CI
33
on:
44
push:
55
branches: [main, master]
6+
paths-ignore:
7+
- '**.md'
8+
- 'LICENSE'
69
pull_request:
710
branches: [main, master]
11+
paths-ignore:
12+
- '**.md'
13+
- 'LICENSE'
814

915
jobs:
1016
test:

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Download the installer (`.exe`) from [GitHub Releases](https://github.com/Simply
6060

6161
### Linux
6262

63-
**Debian/Ubuntu:**
63+
**Debian/Ubuntu/Raspberry Pi OS:**
6464

6565
```bash
6666
# Download the .deb package from GitHub Releases, then:
@@ -82,6 +82,8 @@ sudo dnf install pcsc-lite
8282
sudo systemctl enable --now pcscd
8383
```
8484

85+
> **Atomic Distributions (Fedora Silverblue, Kinoite, etc.):** You can run NFC Agent inside a distrobox container. Install the `.rpm` package in the container, apply the kernel module fix on the host OS, then run `nfc-agent` from the container.
86+
8587
**Arch Linux / Other:**
8688

8789
```bash
@@ -100,9 +102,9 @@ sudo systemctl enable --now pcscd
100102

101103
> **Note:** Unlike the `.deb` and `.rpm` packages, the tar.gz installation requires manual setup of the PC/SC daemon. If you see "No readers found", ensure `pcscd` is running (`systemctl status pcscd`).
102104
103-
**Kernel Module Fix (tar.gz installations only)**
105+
**Important: Kernel Module Fix (All Distributions)**
104106

105-
The `.deb` and `.rpm` packages automatically install the kernel module blacklist and unload conflicting modules. For tar.gz installations, you need to do this manually:
107+
The Linux kernel's NFC subsystem may claim certain readers (especially ACR122U) before pcscd can access them. Run the following after installation:
106108

107109
```bash
108110
# Blacklist conflicting kernel modules
@@ -115,8 +117,6 @@ sudo modprobe -r pn533_usb pn533 nfc 2>/dev/null || true
115117
sudo systemctl restart pcscd
116118
```
117119

118-
> **Atomic Distributions (Fedora Silverblue, Kinoite, etc.):** You can run NFC Agent inside a distrobox container. Install the `.rpm` package in the container—the blacklist file will be installed to the shared `/etc/modprobe.d/` on the host. Alternatively, apply the kernel module fix manually on the host OS, then run `nfc-agent` from the container.
119-
120120
## Quick Start
121121

122122
1. **Connect** your NFC reader via USB
@@ -294,7 +294,7 @@ NFC Agent uses the PC/SC (Personal Computer/Smart Card) interface to communicate
294294

295295
**Linux: Kernel NFC modules conflict**
296296

297-
The Linux kernel's NFC subsystem may claim certain readers before pcscd can access them. The `.deb` and `.rpm` packages handle this automatically. For tar.gz installations, check with `lsmod | grep pn533`—if modules are loaded, follow the **Kernel Module Fix** steps in the [Linux installation section](#linux).
297+
The Linux kernel's NFC subsystem may claim certain readers before pcscd can access them. Check with `lsmod | grep pn533`—if modules are loaded, follow the **Kernel Module Fix** steps in the [Linux installation section](#linux).
298298

299299
**Arch Linux with ACS readers:** Install the `acsccid` driver from AUR (`yay -S acsccid`) and restart pcscd.
300300

0 commit comments

Comments
 (0)