From bf3441205f73958382b83ec058f58fe3baf6a55f Mon Sep 17 00:00:00 2001 From: Radi Radev Date: Mon, 5 Aug 2024 08:17:37 +0200 Subject: [PATCH] Move citation into .cff (#1622) --- CITATION.cff | 18 ++++++++++++++++++ README.md | 15 +-------------- 2 files changed, 19 insertions(+), 14 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..0f4efb644 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,18 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - family-names: Susmelj + given-names: Igor + - family-names: Heller + given-names: Matthias + - family-names: Wirth + given-names: Philipp + - family-names: Prescott + given-names: Jeremy + - family-names: Ebner + given-names: Malte + - name: "et al." +title: "Lightly" +type: software +url: "https://github.com/lightly-ai/lightly" +date-released: 2020 diff --git a/README.md b/README.md index 216d87260..e78d075b1 100644 --- a/README.md +++ b/README.md @@ -411,17 +411,4 @@ You can find out more about the company and it's services by following the links - [Homepage](https://www.lightly.ai) - [Web-App](https://app.lightly.ai) -- [Lightly Solution Documentation (Lightly Worker & API)](https://docs.lightly.ai/) - -## BibTeX - -If you want to cite the framework feel free to use this: - -```bibtex -@article{susmelj2020lightly, - title={Lightly}, - author={Igor Susmelj and Matthias Heller and Philipp Wirth and Jeremy Prescott and Malte Ebner et al.}, - journal={GitHub. Note: https://github.com/lightly-ai/lightly}, - year={2020} -} -``` +- [Lightly Solution Documentation (Lightly Worker & API)](https://docs.lightly.ai/) \ No newline at end of file