diff --git a/README.md b/README.md new file mode 100644 index 00000000..66d3ec22 --- /dev/null +++ b/README.md @@ -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 \#define WIICAMERA in [Wii.h](https://github.com/felis/USB_Host_Shield_2.0/blob/master/Wii.h). \ No newline at end of file