specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Projects Releases Packages Wiki Activity

Added info on how to build Doxygen documentation

Browse source
This commit is contained in:
Kristian Sloth Lauszus 2013-05-07 01:22:31 +02:00
parent d23e32fc4e
commit c7e06b6bf6
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# USB Host Library Rev.2.0
The code is released under the GNU General Public License.
__________
This is the documentation for the USB Host Library.
It is generated using [Doxygen](http://www.stack.nl/~dimitri/doxygen/) and hosted using [Github Pages](https://help.github.com/categories/20/articles).
In order to build the documentation you will need the [Doxyfile](Doxyfile) and [imageStyle.css](imageStyle.css) files.
Also since there is a bug in Doxygen you will need to add \ in front of the @-sign in [Oleg's email address](https://github.com/felis/USB_Host_Shield_2.0#developed-by) in the [README.md](https://github.com/felis/USB_Host_Shield_2.0#developed-by) file.
Also please uncomment <code>\#define WIICAMERA</code> in [Wii.h](https://github.com/felis/USB_Host_Shield_2.0/blob/master/Wii.h).