From 4c2bf7fd1630c83ae0f6f7c9543c09aee0511221 Mon Sep 17 00:00:00 2001
From: cithraidt <lwcloneu2@cithraidt.de>
Date: Wed, 11 Dec 2013 23:30:29 +0100
Subject: [PATCH] readme text

---
 README.md  |  2 --
 readme.txt | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 2 deletions(-)
 delete mode 100644 README.md
 create mode 100644 readme.txt

diff --git a/README.md b/README.md
deleted file mode 100644
index 92bb2ff..0000000
--- a/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-lwcloneu2
-=========
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..1b86c4a
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,38 @@
+LWCloneU2
+=========
+
+A firmware for Atmel AVR microcontroller for controlling
+LEDs or Light Bulbs via USB *and* a Joystick/Mouse/Keyboard Encoder.
+
+The device is compatible with the LED-WIZ controller on the USB protocol level and
+thus can be used with many existing software.
+Additionally the firmware allows to add panel support, i.e. up to 4 yoysticks, 1 mouse, 1 keyboard and more.
+That is with one board you can get an input encoder and an LED output controller perfectly suited for MAME.
+
+The LWCloneU2 project contains a compatible driver DLL "ledwiz.dll" replacement that fixes some bugs of 
+the original one and does not block your main application, i.e. the I/O is fully asynchron.
+
+
+Supported Hardware
+==================
+- Custom Breakout Board with ATMega32U2
+- Arduino Leonardo (ATMega32U4)
+- Arduino Mega 2560 (tested with Rev. 3)
+- Arduino Uno Rev. 2/3 (untested)
+
+
+Building the firmware
+=====================
+
+In order to build all this, you need a recent toolchain for AVR microcontroller,
+e.g. the 'AVR Toolchain 3.4.2-1573' from Atmel or the one that is bundled with the Atmel AVRStudio.
+Get the sources from the Git repository, then do a 'git submodule update'
+in order to get the required LUFA (USB framework) sources.
+Then a 'make' should build the firmwares for all supported platforms.
+
+
+Building the Windows DLL
+========================
+
+There are project files for Visualstudio 2008 Express and Visualstudio 2012 Express.
+The VS 2012 solution supports creating a 64 bit DLL.