From ee24df943e59f5837e9d5c2da9fdb9a2107e15f3 Mon Sep 17 00:00:00 2001 From: Albert Alonso Date: Wed, 15 Jan 2025 08:18:30 +0100 Subject: [PATCH] docs: update readme to include bibtex entry It is common for research projects to use software such as boundvor, and some journals require authors to cite the libraries they use. Now boundvor has a quick citation entry to ease the process. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 53646f7..cd73616 100644 --- a/README.md +++ b/README.md @@ -28,5 +28,17 @@ bounding_box = np.array([[0., 0.], [0., 1.], [1., 1.], [1., 0.]]) voronoi = BoundedVoronoi(points, bounds=bounding_box) ``` +## Citation +If you use `boundvor` in your research and want to reference it, please cite it as follows: +``` +@software{alonso_boundvor, + author = {Alonso, Albert}, + title = {boundvor: Voronoi Diagram Clipped on a Polygon}, + url = {https://github.com/alonfnt/boundvor}, + version = {0.1.1} +} +``` + ## License MIT License +