summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..2f50da9
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,10 @@
+ZFM20 FINGERPRINT MODULE
+
+This is a UART-based driver for ZFM20 family of fingerprint modules for AVR
+microcontrollers. I wrote this for and tested with ATmega328P. It should work
+with other AVR microcontrollers as well.
+
+Since ATmega328P has only one hardware UART, I'm using lynxzp's software UART
+implementation [1] for debugging purposes.
+
+[1] https://github.com/lynxzp/Software_UART_for_AVR