Use the README as the documentation main page

This commit is contained in:
Dimitri Lozeve 2021-03-07 17:57:23 +01:00
parent 1b647ede36
commit f7712da8d2
3 changed files with 8 additions and 8 deletions

View file

@ -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
View file

@ -0,0 +1,6 @@
# ShaderTool
[![build](https://github.com/dlozeve/ShaderTool/actions/workflows/build.yml/badge.svg)](https://github.com/dlozeve/ShaderTool/actions/workflows/build.yml)
[![docs](https://github.com/dlozeve/ShaderTool/actions/workflows/docs.yml/badge.svg)](https://dlozeve.github.io/ShaderTool/)
Live tool for developing OpenGL shaders interactively.

View file

@ -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.