Update README.md

This commit is contained in:
David Rodenkirchen 2026-04-02 09:00:59 +00:00
parent 99bba1b59a
commit c416eb8cef

View File

@ -4,6 +4,14 @@ This repository contains the tooling around NFC readers/writers.
Currently supported NFC Device: ACR 1252U Currently supported NFC Device: ACR 1252U
## Installation
Make sure you have the apt packages `python3-dev` and `libpcsclite-dev` installed before installing the dependencies from `requirements.txt`.
## Configuration
The root path of the installation (next to `NfcReaderService.py`) needs to contain the `hmac_key.txt`. The correct key can be retrieved from sys admin.
## Tools: ## Tools:
- card_reader - card_reader
@ -17,6 +25,6 @@ Currently supported NFC Device: ACR 1252U
## Intended usage ## Intended usage
Start `NfcReaderService` on terminals where LAN team needs to verify guest identity, EZGG LAN manager then reads user ID from clipboard. Start `NfcReaderService` on terminals where LAN team needs to verify guest identity, EZGG LAN manager then reads user ID from clipboard.
`NfcReaderService` may be used as part of a systemd unit, to automate the startup process. `NfcReaderService` may be used as part of a systemd unit, to automate the startup process. See service file for additional info.
Run `card_writer` when preparing tickets. Run `card_writer` when preparing tickets.