removed some github specific markdown from README
added doxygen comments