From 83208bb2e7a0dba6876ba90389cf36cd5b2c867a Mon Sep 17 00:00:00 2001 From: Andrej Leban Date: Wed, 18 Mar 2020 20:28:53 +0100 Subject: [PATCH] Use README.md as doxygen's main page. --- README.md | 1 + doxyfile | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bfb875..f782d87 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ NOTE: I have stayed away from *C*-like input/output parameters and have replaced [*common*](https://github.com/andleb/common) repository for utility classes & functions. The project is built via *CMake*. One can, of course, modify the *CMake* configuration at will or use one's own. +The documentation is to be built with *Doxygen* from the provided *doxyfile*. ## Authors diff --git a/doxyfile b/doxyfile index f23ceed..80c7abf 100644 --- a/doxyfile +++ b/doxyfile @@ -791,7 +791,8 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = mains \ - src + src \ + README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -983,7 +984,7 @@ FILTER_SOURCE_PATTERNS = # (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. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing