diff --git a/README.md b/README.md index a21c41e..2ecda04 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ This repository contains the tooling around NFC readers/writers. 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: - card_reader @@ -17,6 +25,6 @@ Currently supported NFC Device: ACR 1252U ## Intended usage 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. \ No newline at end of file