64 lines
2.5 KiB
Text
64 lines
2.5 KiB
Text
readme.txt file for Arduino glcd library
|
|
|
|
INSTALL
|
|
This library should be unziped into a folder named glcd in the libraries
|
|
directory. If you already have a folder called libraries in your Arduino
|
|
sketchbook directory, unzip the glcd files there. If not, create a
|
|
folder called libraries in the sketchbook folder, and drop the library
|
|
folder here.
|
|
Alternatively you can install it directly in the arduino distribution
|
|
by placing it in the libraries directory where the arduino distribution
|
|
was installed. For arduino release 0018 and later that would be:
|
|
{installdir}/libraries
|
|
Then re-start the Arduino programming environment, and you should see the glcd
|
|
library in the Sketch > Import LIbrary menu.
|
|
|
|
DOCUMENTATION
|
|
The documentation can be found in the doc directory. There is an
|
|
overview document named GLCD_Documentation.pdf and detailed reference
|
|
material in GLCDref.htm.
|
|
|
|
CONFIG
|
|
Configuration files for defining pins and panel charactoristics are in the
|
|
config folder. The library is capable of auto-configuring when using a
|
|
standard processor and panel with the suggested wiring.
|
|
If you need to modify the configuration see the documentation for details
|
|
on how to do this.
|
|
|
|
EXAMPLES
|
|
The example sketches are in the examples folder and can be accessed from
|
|
the IDE menu by selecting File > Examples > glcd
|
|
|
|
GLCDdemo provides a good introduction to the functionality of the library.
|
|
|
|
GLCDdiags is a test sketch to help get things up and running and provides
|
|
diagnostic information that can help with troubleshooting.
|
|
|
|
Other example sketches are provided that show how to use various capabilities
|
|
of the library.
|
|
|
|
FONTS
|
|
The library is supplied with fixed and variable width font definitons
|
|
located in the fonts folder. See the documentation for information on adding
|
|
your own fonts to this folder.
|
|
|
|
BITMAPS
|
|
Bitmap images are stored in the bitmaps folder. The documentation
|
|
describes how to create you own bitmaps using a utility provided in the
|
|
bitmaps\glcdMakeBitmaps folder
|
|
|
|
OTHER FOLDERS
|
|
The include and device folders contain low level system files.
|
|
These do not need to be modifed for normal operation.
|
|
|
|
LICENCE
|
|
The Arduino GLCD library files are either licensed under the terms of the
|
|
GNU Lesser General Public License or are compatible with this license when
|
|
the GLCD library code is used in the Arduino software environment.
|
|
See licence.txt for details.
|
|
|
|
The glcd library was created by Michael Margolis. Extensive enhancements
|
|
including the majority of the improvements in this release were led
|
|
by Bill Perry.
|
|
|
|
|