aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTectu <joel@unormal.org>2012-05-29 02:14:15 +0200
committerTectu <joel@unormal.org>2012-05-29 02:14:15 +0200
commit90e756b420c4d1945d52ba6d3091a48657d91e5a (patch)
tree53c7ec4a3acaa1e6cf6d9dd46d382b2a1209df40 /README.md
parent1fcb2ba9c26ba2209f882309b5d8019cf3eb642c (diff)
downloaduGFX-90e756b420c4d1945d52ba6d3091a48657d91e5a.tar.gz
uGFX-90e756b420c4d1945d52ba6d3091a48657d91e5a.tar.bz2
uGFX-90e756b420c4d1945d52ba6d3091a48657d91e5a.zip
documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 46 insertions, 0 deletions
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.
+