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 <collin.doering@rekahsoft.ca>
This commit is contained in:
Collin J. Doering 2016-01-12 04:54:49 -05:00
parent 28a71ff8e8
commit 3a38d3ff18
2 changed files with 38 additions and 4 deletions

View File

@ -3,24 +3,58 @@
* [Features](#features) * [Features](#features)
* [Tools](#tools) * [Tools](#tools)
* [License](#license) * [License](#license)
* [Building](#building) * [Usage](#usage)
* [Issues](#issues) * [Issues](#issues)
* [Road Map](#road-map) * [Road Map](#road-map)
## Features <a name="features"></a> ## Features <a name="features"></a>
- 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 <a name="tools"></a> ## Tools <a name="tools"></a>
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 <a name="license"></a> ## License <a name="license"></a>
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 <a name="building"></a> ## Usage <a name="usage"></a>
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 <a name="issues"></a> ## Issues <a name="issues"></a>
- 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 <a name="road-map"></a> ## Road Map <a name="road-map"></a>
- 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/ [Gnu Emacs]: http://www.gnu.org/software/emacs/
[GPLv3]: https://www.gnu.org/licenses/gpl.html [GPLv3]: https://www.gnu.org/licenses/gpl.html

View File

@ -906,7 +906,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub # (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. # 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 # Configuration options related to source browsing