Use the README as the documentation main page
This commit is contained in:
parent
1b647ede36
commit
f7712da8d2
3 changed files with 8 additions and 8 deletions
4
Doxyfile
4
Doxyfile
|
@ -790,7 +790,7 @@ WARN_LOGFILE =
|
|||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = "src"
|
||||
INPUT = README.md src
|
||||
|
||||
# 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
|
||||
|
@ -982,7 +982,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
|
||||
|
|
6
README.md
Normal file
6
README.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
# ShaderTool
|
||||
|
||||
[](https://github.com/dlozeve/ShaderTool/actions/workflows/build.yml)
|
||||
[](https://dlozeve.github.io/ShaderTool/)
|
||||
|
||||
Live tool for developing OpenGL shaders interactively.
|
|
@ -1,6 +0,0 @@
|
|||
* ShaderTool
|
||||
|
||||
[[https://github.com/dlozeve/ShaderTool/actions/workflows/build.yml][https://github.com/dlozeve/ShaderTool/actions/workflows/build.yml/badge.svg]]
|
||||
[[https://dlozeve.github.io/ShaderTool/][https://github.com/dlozeve/ShaderTool/actions/workflows/docs.yml/badge.svg]]
|
||||
|
||||
Live tool for developing OpenGL shaders interactively.
|
Loading…
Add table
Add a link
Reference in a new issue