From f7712da8d21b5a7846ed3846408bcc9d14083427 Mon Sep 17 00:00:00 2001 From: Dimitri Lozeve Date: Sun, 7 Mar 2021 17:57:23 +0100 Subject: [PATCH] Use the README as the documentation main page --- Doxyfile | 4 ++-- README.md | 6 ++++++ README.org | 6 ------ 3 files changed, 8 insertions(+), 8 deletions(-) create mode 100644 README.md delete mode 100644 README.org diff --git a/Doxyfile b/Doxyfile index 275046f..d0d7335 100644 --- a/Doxyfile +++ b/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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..200757f --- /dev/null +++ b/README.md @@ -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. diff --git a/README.org b/README.org deleted file mode 100644 index 9cda8c9..0000000 --- a/README.org +++ /dev/null @@ -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.