From efc3017df84cc0ea8c7776e207cc00cbd7ac5157 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Tue, 8 Aug 2023 14:13:29 +0200 Subject: [PATCH] chore(paper): add paper's doi, update badges and add CFF --- .bumpversion.cfg | 4 ++++ CITATION.cff | 32 ++++++++++++++++++++++++++++++++ README.md | 8 ++++++-- 3 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 CITATION.cff diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 184e96a..30ebcfa 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -10,3 +10,7 @@ replace = __version__ = "{new_version}" [bumpversion:file:pyproject.toml] search = version = "{current_version}" replace = version = "{new_version}" + +[bumpversion:file:CITATION.cff] +search = version: {current_version} +replace = version: {new_version} diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..b37e834 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,32 @@ +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: Manim Slides +message: A Python package for presenting Manim content anywhere +type: software +authors: + - name: Jérome Eertmans + orcid: 'https://orcid.org/0000-0002-5579-5360' + website: 'https://eertmans.be' +identifiers: + - type: doi + value: 10.21105/jose.00206 + description: The paper presenting the software. +repository-code: 'https://github.com/jeertmans/manim-slides' +url: 'https://eertmans.be/manim-slides' +abstract: >- + Manim Slides is a Python package that makes presenting + Manim animations straightforward. With minimal changes + required to pre-existing code, one can slide through + + animations in a PowerPoint-like manner, or share its + slides online using ReavealJS’ power. +keywords: + - Education + - Math Animations + - Presentation Tool + - PowerPoint + - Python +license: MIT +version: v4.15.0 diff --git a/README.md b/README.md index a0a77f9..b8d4af5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ [![PyPI - Downloads][pypi-download-badge]][pypi-version-url] [![Documentation][documentation-badge]][documentation-url] [![DOI][doi-badge]][doi-url] +[![JOSE Paper][jose-badge]][jose-url] [![codecov][codecov-badge]][codecov-url] # Manim Slides @@ -261,7 +262,10 @@ you can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com). [pypi-download-badge]: https://img.shields.io/pypi/dm/manim-slides [documentation-badge]: https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=documentation&up_color=green&up_message=online&url=https%3A%2F%2Feertmans.be%2Fmanim-slides%2F [documentation-url]: https://eertmans.be/manim-slides/ -[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.7971361.svg -[doi-url]: https://doi.org/10.5281/zenodo.7971361 +[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.8215167.svg +[doi-url]: https://doi.org/10.5281/zenodo.8215167 +[jose-badge]: https://jose.theoj.org/papers/10.21105/jose.00206/status.svg +[jose-url]: https://doi.org/10.21105/jose.00206 + [codecov-badge]: https://codecov.io/gh/jeertmans/manim-slides/branch/main/graph/badge.svg?token=8P4DY9JCE4 [codecov-url]: https://codecov.io/gh/jeertmans/manim-slides