File tree Expand file tree Collapse file tree 2 files changed +4
-2
lines changed Expand file tree Collapse file tree 2 files changed +4
-2
lines changed Original file line number Diff line number Diff line change @@ -35,6 +35,7 @@ NOTE: I have stayed away from *C*-like input/output parameters and have replaced
35
35
[ * common* ] ( https://github.com/andleb/common ) repository for utility classes & functions.
36
36
37
37
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* .
38
39
39
40
40
41
## Authors
Original file line number Diff line number Diff line change @@ -791,7 +791,8 @@ WARN_LOGFILE =
791
791
# Note: If this tag is empty the current directory is searched.
792
792
793
793
INPUT = mains \
794
- src
794
+ src \
795
+ README.md
795
796
796
797
# This tag can be used to specify the character encoding of the source files
797
798
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -983,7 +984,7 @@ FILTER_SOURCE_PATTERNS =
983
984
# (index.html). This can be useful if you have a project on for instance GitHub
984
985
# and want to reuse the introduction page also for the doxygen output.
985
986
986
- USE_MDFILE_AS_MAINPAGE =
987
+ USE_MDFILE_AS_MAINPAGE = README.md
987
988
988
989
#---------------------------------------------------------------------------
989
990
# Configuration options related to source browsing
You can’t perform that action at this time.
0 commit comments