diff options
| author | Tectu <joel@unormal.org> | 2012-08-13 08:47:27 +0200 |
|---|---|---|
| committer | Tectu <joel@unormal.org> | 2012-08-13 08:47:27 +0200 |
| commit | bcccde53e6af28dcc13756516ed2806b64c60da3 (patch) | |
| tree | 5d924294993d712eecc8cde35a25a171b638c216 | |
| parent | 9d886f2451c7a277257bd5b779581527238e12aa (diff) | |
| download | uGFX-bcccde53e6af28dcc13756516ed2806b64c60da3.tar.gz uGFX-bcccde53e6af28dcc13756516ed2806b64c60da3.tar.bz2 uGFX-bcccde53e6af28dcc13756516ed2806b64c60da3.zip | |
doc updates
| -rw-r--r-- | docs/usage.txt | 32 | ||||
| -rw-r--r-- | readme.txt | 19 |
2 files changed, 51 insertions, 0 deletions
diff --git a/docs/usage.txt b/docs/usage.txt new file mode 100644 index 00000000..e2d33c18 --- /dev/null +++ b/docs/usage.txt @@ -0,0 +1,32 @@ +To include any of these functions/drivers in your project...
+
+ 1/ Specify the path to the LCDLIB. If none defined, default is $(CHIBIOS)/ext/lcd
+
+ 2/ In your project Makefile (amongst similiar lines but after the hal line) add the line...
+ include $(LCDLIB)/lcd.mk
+
+ 3/ Add $(LCDSRC) and $(LCDINC) to your SRCS and INCDIR of your projects Makefile
+
+ 4/ In your project Makefile add the makefiles for any specific drivers you want e.g
+ include $(LCDLIB)/halext/drivers/touchpad/touchpadXPT2046/touchpad_lld.mk
+ include $(LCDLIB)/halext/drivers/gdisp/gdispNokia6610/gdisp_lld.mk
+
+ 5/ In your project halconf.h turn on the support you want eg.
+ /**
+ * @brief Enables the Touchpad subsystem.
+ */
+ #if !defined(HAL_USE_TOUCHPAD) || defined(__DOXYGEN__)
+ #define HAL_USE_TOUCHPAD TRUE
+ #endif
+
+ /**
+ * @brief Enables the GDISP subsystem.
+ */
+ #if !defined(HAL_USE_GDISP) || defined(__DOXYGEN__)
+ #define HAL_USE_GDISP TRUE
+ /* Any driver specific defines required go here. The below line is an example. */
+ #define GDISP_NEED_MULTITHREAD TRUE
+ #endif
+
+ 6/ Do a make clean.
+
diff --git a/readme.txt b/readme.txt new file mode 100644 index 00000000..0b67c9b0 --- /dev/null +++ b/readme.txt @@ -0,0 +1,19 @@ +## Doxygen
+run doxygen in the toplevel directory to generate the doxygen documentation in html
+
+
+
+## Wiki
+please read the wiki pages to this project carefully, before you ask any questions:
+
+http://chibios.org/dokuwiki/doku.php?id=chibios:community
+
+
+
+## Maintainer & Contributors
+please read the contributors.txt file which contains a full history of each contribution
+
+Maintainer:
+ - Joel Bodenmann aka Tectu <joel@unormal.org>
+
+
|