From 3a38d3ff18b7acf972617940ebcc0ec45e659c49 Mon Sep 17 00:00:00 2001 From: "Collin J. Doering" Date: Tue, 12 Jan 2016 04:54:49 -0500 Subject: [PATCH] Update README.md and doxygen front page Use README.md as the front page of the documentation generated by doxygen. Signed-off-by: Collin J. Doering --- README.md | 40 +++++++++++++++++++++++++++++++++++++--- doxygen.conf | 2 +- 2 files changed, 38 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 78f6f69..dbf7f6e 100644 --- a/README.md +++ b/README.md @@ -3,24 +3,58 @@ * [Features](#features) * [Tools](#tools) * [License](#license) -* [Building](#building) +* [Usage](#usage) * [Issues](#issues) * [Road Map](#road-map) ## Features +- Supports both 8-bit and 4-bit modes of LCD's +- Configurable, so it should work on most devices, albeit with some tweaking +- Read/Write the character LCD +- Control the display using ANSI and ASCII escapes +- Read/Write custom characters to memory and/or the LCD display (not fully implemented) + ## Tools +This project wouldn't be possible without the following great open source tools: + +- AVR-GCC, [AVR-libc][], and AVR-binutils which form the compiler toolchain that makes open + source development for AVR microcontrollers possible. +- [avrdude][] to do in system programming of the AVR microcontrollers +- [doxygen][] to generate documentation. +- [Gnu Emacs][], because how else would I enter text? + ## License -Code licensed under ([GPLv3][]. Please see the LICENSE file for full details. +Code licensed under [GPLv3][]. Please see the LICENSE file for full details. -## Building +## Usage + +Clone this repository and modify lcdLibConfig.h to your needs. See the documentation for more +details. + + git clone http://git.rekahsoft.ca/lcdLib.git + doxygen doxygen.conf # If you want to generate offline documentation ## Issues +- No interface is given to read/write custom characters, though it can be done manually using + the lower level plumbing function `writeLCDInstr`. +- No examples of using the library are currently given but do exist in the git history. They + have been split out into their own repository's and soon will be re-added as git submodules. + Util that time look into the git history. + ## Road Map +- Add support for reading/writing custom characters to memory/display +- Add examples projects utilizing lcdLib as git submodules +- Finish documenting functions +- Put the [doxygen][] generated documentation for this library online + +[AVR-libc]: http://www.nongnu.org/avr-libc/ +[avrdude]: http://savannah.nongnu.org/projects/avrdude +[doxygen]: http://www.stack.nl/~dimitri/doxygen/ [Gnu Emacs]: http://www.gnu.org/software/emacs/ [GPLv3]: https://www.gnu.org/licenses/gpl.html diff --git a/doxygen.conf b/doxygen.conf index 28f08db..a6c9be2 100644 --- a/doxygen.conf +++ b/doxygen.conf @@ -906,7 +906,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing