Skip to content

Commit 83208bb

Browse files
committed
Use README.md as doxygen's main page.
1 parent cb5b127 commit 83208bb

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ NOTE: I have stayed away from *C*-like input/output parameters and have replaced
3535
[*common*](https://github.com/andleb/common) repository for utility classes & functions.
3636

3737
The project is built via *CMake*. One can, of course, modify the *CMake* configuration at will or use one's own.
38+
The documentation is to be built with *Doxygen* from the provided *doxyfile*.
3839

3940

4041
## Authors

doxyfile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,8 @@ WARN_LOGFILE =
791791
# Note: If this tag is empty the current directory is searched.
792792

793793
INPUT = mains \
794-
src
794+
src \
795+
README.md
795796

796797
# This tag can be used to specify the character encoding of the source files
797798
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -983,7 +984,7 @@ FILTER_SOURCE_PATTERNS =
983984
# (index.html). This can be useful if you have a project on for instance GitHub
984985
# and want to reuse the introduction page also for the doxygen output.
985986

986-
USE_MDFILE_AS_MAINPAGE =
987+
USE_MDFILE_AS_MAINPAGE = README.md
987988

988989
#---------------------------------------------------------------------------
989990
# Configuration options related to source browsing

0 commit comments

Comments
 (0)