From 147825262419a479ae32f8d01269d169860a3b63 Mon Sep 17 00:00:00 2001 From: Johannes Holke Date: Thu, 22 Sep 2022 11:24:27 +0200 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f87fd66a0..c01ee990f8 100644 --- a/README.md +++ b/README.md @@ -120,8 +120,21 @@ For a debugging mode with static linkage (makes using gdb and valgrind more comf and read the corresponding Wiki pages starting with [Step 0 - Helloworld](https://github.com/holke/t8code/wiki/Step-0---Hello-World). A sophisticated example of a complete numerical simulation is our finite volume solver of the advection equation in `example/advection`. - - ### Publications + + +### Documentation + +t8code uses [Doxygen](https://doxygen.nl/) to generate the code documentation. You can build the documentation with + +``` +make doxygen +``` + +and then find the generated files in the `/doxygen` subfolder. + +You can also find the documentation of our releases on the [t8code website](https://dlr-amr.github.io/t8code/pages/documentation.html). + +### Publications An (incomplete) list of publications related to t8code: