From c99e49a5d71cf6f4a71c9eb87ad7bcae1f96abc3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?King=20K=C3=A9vin?= <kingkevin@cuvoodoo.info>
Date: Wed, 27 Jan 2016 16:35:44 +0100
Subject: [PATCH] add short description

---
 README | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..9dd6494
--- /dev/null
+++ b/README
@@ -0,0 +1,13 @@
+this micro-controller firmware controls a vacuum fluorescent display (VFD).
+
+the VFD has been salvaged from a Samsung SER6500 cash register.
+it already included supertex HV518 VFD drivers.
+
+the micro-controller used is a STM32F103C8T6. with the libopencm3 library.
+
+the firmware starts by testing all segments of the VFD, plays an animation, and finally displayed the text typed in over the USB CDC ACM or USART1 ports.
+
+the data is shifted out from the micro-controller to the drivers using SPI.
+a timer will periodically refresh all parts of the VFD.
+
+more details are available at https://wiki.cuvoodoo.info/doku.php?id=vfd_driver.