Embed readme in mainpage (doxygen)

Question

Is there a way to embed a plain-text file (README.txt) into a mainpage for doxygen? (I'm maing it with cmake, so I could dump the variable but I'd think this type of thing would be built in).

Answer 1

Sure. In your mainpage.dox (or whatever you call it), place a link to your README.txt as a separate doxygen page.

\mainpage FooBar

...
\section other_docs Additional Documentation`

...
Key features that distinguish the current release, build instructions,
and a history of Project FooBar are described in the
\ref README "Foobar README file".

and then later on, generate that page by making your README.txt a plain text page file.

\page README README
\verbinclude README.txt