From 79b55722afbd30a5deecdd57b6ff48ae6a23dc62 Mon Sep 17 00:00:00 2001
From: Michael Schlottke-Lakemper <michael@sloede.com>
Date: Fri, 1 Nov 2024 07:22:15 +0100
Subject: [PATCH] Add DOI to README and docs (#64)

* Add DOI to README and docs

* Different bibtex id
---
 README.md         |  6 +++---
 docs/src/index.md | 16 ++++++++++++++++
 2 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5275cf11..177645f2 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
 [![Build Status](https://github.com/trixi-framework/HOHQMesh.jl/workflows/CI/badge.svg)](https://github.com/trixi-framework/HOHQMesh.jl/actions?query=workflow%3ACI)
 [![Coveralls](https://coveralls.io/repos/github/trixi-framework/HOHQMesh.jl/badge.svg?branch=main)](https://coveralls.io/github/trixi-framework/HOHQMesh.jl?branch=main)
 [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.TODO.svg)](https://doi.org/10.5281/zenodo.TODO)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13959071.svg)](https://doi.org/10.5281/zenodo.13959071)
 
 This package is a Julia frontend to the Fortran-based *High Order Hex-Quad Mesher*
 (a.k.a. [**HOHQMesh**](https://github.com/trixi-framework/HOHQMesh)) created and developed by
@@ -92,12 +92,12 @@ Additional examples are available in the [Tutorials](https://trixi-framework.git
 ## Referencing
 If you use HOHQMesh.jl in your own research, please cite this repository as follows:
 ```bibtex
-@misc{kopriva2024hohqmesh,
+@misc{kopriva2024hohqmeshjl,
   title={{HOHQM}esh.jl: A Julia frontend to the Fortran-based HOHQMesh mesh generator for high order elements},
   author={Kopriva, David A and Winters, Andrew R and Schlottke-Lakemper, Michael and Ranocha, Hendrik},
   year={2024},
   howpublished={\url{https://github.com/trixi-framework/HOHQMesh.jl}},
-  doi={10.5281/zenodo.TODO}
+  doi={10.5281/zenodo.13959071}
 }
 ```
 Please also consider citing [HOHQMesh](https://github.com/trixi-framework/HOHQMesh) itself (see
diff --git a/docs/src/index.md b/docs/src/index.md
index 0a64ad34..c3f3258a 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -89,6 +89,22 @@ files that are saved and the output of mesh statistics to the screen.
 Further explanation of the interactive functionality can be found [here](@ref InteractiveTool).
 Additional examples are available in the [Tutorials](@ref).
 
+
+## Referencing
+If you use HOHQMesh.jl in your own research, please cite this repository as follows:
+```bibtex
+@misc{kopriva2024hohqmeshjl,
+  title={{HOHQM}esh.jl: A Julia frontend to the Fortran-based HOHQMesh mesh generator for high order elements},
+  author={Kopriva, David A and Winters, Andrew R and Schlottke-Lakemper, Michael and Ranocha, Hendrik},
+  year={2024},
+  howpublished={\url{https://github.com/trixi-framework/HOHQMesh.jl}},
+  doi={10.5281/zenodo.13959071}
+}
+```
+Please also consider citing [HOHQMesh](https://github.com/trixi-framework/HOHQMesh) itself (see
+[here](https://github.com/trixi-framework/HOHQMesh#referencing) for details on how to do this).
+
+
 ## [Authors](@id authors-index-md)
 HOHQMesh.jl is maintained by the
 [Trixi authors](https://github.com/trixi-framework/Trixi.jl/blob/main/AUTHORS.md).