Initial commit: project docs and ignore rules

2026-05-03 23:20:16 -07:00
commit 1e0353ac03
3 changed files with 412 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,19 @@
+# emulator_firmware
+
+**Emulator module** for the dual-PN532 NFC system: receives NFC captures over **ESP-NOW**, drives PN532 emulation, and logs to **SD card** when available.
+
+## Build
+
+Built via PlatformIO from the **workspace root** (same `platformio.ini` as the listener):
+
+```bash
+cd ..
+pio run -e emulator
+pio run -e emulator -t upload
+```
+
+Requires `../common/` for `nfc_protocol.h` and related sources.
+
+## Hardware
+
+See the root [README](../README.md) for ESP32-C3 ↔ PN532 and SD wiring.