From 90e756b420c4d1945d52ba6d3091a48657d91e5a Mon Sep 17 00:00:00 2001
From: Tectu <joel@unormal.org>
Date: Tue, 29 May 2012 02:14:15 +0200
Subject: documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..7071d707
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+## Features
+
+Supported drawing functions:
+
+	- Pixels
+	- Lines
+	- Rectanges (frames/filled)
+	- Circles (frames/filled)
+	- character
+	- string
+
+
+
+
+# Install
+
+## checkout Driver code into ext/
+cd chibios/ext
+git clone https://github.com/tectu/Chibios-LCD-Driver lcd
+
+## Edit Makefile:
+include lcd.mk:
+	include $(CHIBIOS)/ext/lcd/lcd.mk
+
+Add $(LCDSRC) to CSRC:
+	CSRC = $(PORTSRC) \
+	       $(KERNSRC) \
+	       $(TESTSRC) \
+	       $(HALSRC) \
+	       $(PLATFORMSRC) \
+	       $(BOARDSRC) \
+	       $(FATFSSRC) \
+	       $(LCDSRC) \
+	       $(CHIBIOS)/os/various/evtimer.c \
+	       $(CHIBIOS)/os/various/syscalls.c
+
+Add $(LCDINC) to INCDIR:
+	INCDIR = $(PORTINC) $(KERNINC) $(TESTINC) \
+	         $(HALINC) $(PLATFORMINC) $(BOARDINC) \
+	         $(FATFSINC) \
+	         $(LCDINC) \
+	         $(CHIBIOS)/os/various ../common
+
+## Use
+include glcd.h header file wherever you need it.
+
diff --git a/readme b/readme
deleted file mode 100644
index b183c71b..00000000
--- a/readme
+++ /dev/null
@@ -1,32 +0,0 @@
-Chibios LCD Driver
-
-### checkout Driver code into ext/
-cd chibios/ext
-git clone https://github.com/tectu/Chibios-LCD-Driver lcd
-
-### Edit Makefile:
-include lcd.mk:
-	include $(CHIBIOS)/ext/lcd/lcd.mk
-
-Add $(LCDSRC) to CSRC:
-	CSRC = $(PORTSRC) \
-	       $(KERNSRC) \
-	       $(TESTSRC) \
-	       $(HALSRC) \
-	       $(PLATFORMSRC) \
-	       $(BOARDSRC) \
-	       $(FATFSSRC) \
-	       $(LCDSRC) \
-	       $(CHIBIOS)/os/various/evtimer.c \
-	       $(CHIBIOS)/os/various/syscalls.c
-
-Add $(LCDINC) to INCDIR:
-	INCDIR = $(PORTINC) $(KERNINC) $(TESTINC) \
-	         $(HALINC) $(PLATFORMINC) $(BOARDINC) \
-	         $(FATFSINC) \
-	         $(LCDINC) \
-	         $(CHIBIOS)/os/various ../common
-
-### Use
-include glcd.h header file wherever you need it.
-
-- 
cgit v1.2.3