doc updates
This commit is contained in:
parent
9d886f2451
commit
bcccde53e6
32
docs/usage.txt
Normal file
32
docs/usage.txt
Normal file
@ -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.
|
||||
|
19
readme.txt
Normal file
19
readme.txt
Normal file
@ -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>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user