Merge branch 'develop' into ftr/shell-to-start-sencha

.github/workflows/fair-software.yml

@@ -0,0 +1,15 @@
+name: fair-software
+
+on: push
+
+jobs:
+  verify:
+    name: "fair-software"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: fair-software/[email protected]
+        name: Measure compliance with fair-software.eu recommendations
+        env:
+          PYCHARM_HOSTED: "Trick colorama into displaying colored output" 
+        with:
+          MY_REPO_URL: "https://github.com/${{ github.repository }}"

.howfairis.yml

@@ -0,0 +1 @@
+skip_registry_checks_reason : "registered in NFDI4Culture Registry for Tools & Services at https://nfdi4culture.de/id/E3648"

CITATION.cff

@@ -0,0 +1,50 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Edirom Online
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Daniel
+    family-names: Röwenstrunk
+  - given-names: Peter
+    family-names: Stadler
+  - given-names: Benjamin W.
+    family-names: Bohl
+  - given-names: Nikolaos
+    family-names: Beer
+  - given-names: Kristin
+    family-names: Herold
+  - given-names: Daniel
+    family-names: Jettka
+  - given-names: Stefan
+    family-names: Münnich
+  - given-names: Dennis
+    family-names: Ried
+  - given-names: Dennis
+    family-names: Friedl
+  - given-names: Hizkiel
+    family-names: Alemayehu
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.5347861
+    description: Edirom Online
+repository-code: 'https://github.com/Edirom/Edirom-Online'
+abstract: >-
+  Edirom Online is a software for the presentation and
+  analysis of critical musical editions in a digital format,
+  particularly in the fields of musicology and philology.
+  Edirom Online supports various data formats commonly used
+  in digital humanities, such as TEI (Text Encoding
+  Initiative) for textual data and MEI (Music Encoding
+  Initiative) for musical data, that is visualized with
+  Verovio. This allows for the integration of different data
+  formats, starting in the early days with texts, images and
+  music and adding audio and even film within a single
+  edition.
+license: GPL-3.0
+version: v1.0.0
+date-released: '2024-11-20'

README.md

@@ -1,4 +1,16 @@
-[![Build](https://github.com/Edirom/Edirom-Online/actions/workflows/pre-release.yml/badge.svg?branch=develop&event=push)](https://github.com/Edirom/Edirom-Online/actions/workflows/pre-release.yml) [![NFDI4C Registry](https://nfdi4culture.de/fileadmin/user_upload/registry/badges/nfdi4culturebadge.svg)](https://nfdi4culture.de/id/E3648) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+<div align="center">
+
+[![Build](https://github.com/Edirom/Edirom-Online/actions/workflows/pre-release.yml/badge.svg?branch=develop&event=push)](https://github.com/Edirom/Edirom-Online/actions/workflows/pre-release.yml) 
+[![NFDI4C Registry](https://nfdi4culture.de/fileadmin/user_upload/registry/badges/nfdi4culturebadge.svg)](https://nfdi4culture.de/id/E3648) 
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![GitHub release](https://img.shields.io/github/v/release/Edirom/Edirom-Online.svg)](https://github.com/Edirom/Edirom-Online/releases) 
+[![FAIR checklist badge](https://fairsoftwarechecklist.net/badge.svg)](https://fairsoftwarechecklist.net/v0.2?f=31&a=32113&i=32300&r=133) 
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9746/badge)](https://www.bestpractices.dev/projects/9746)
+[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B%20%20%E2%97%8B%20%20%E2%97%8B-orange)](https://fair-software.eu)
+[![DOI](https://zenodo.org/badge/5966814.svg)](https://zenodo.org/badge/latestdoi/5966814)
+
+</div>
+
 
 <div align="center">
 
@@ -141,6 +153,11 @@ Even if you are not ready (yet) to contribute to this wonderful project, maybe i
 
 Please note that this project is released with a [Contributor Code of Conduct]. By participating in this project you agree to abide by its terms.
 
+## Citation
+
+Please cite the software/repository using the information provided under "Cite this repository" on the right hand side. The APA and BIBTeX citations are fed by information from the CITATION.cff file in this repository which you can also use as a source.
+If you intend to cite unreleased branches or commits please use the commit hash in the citation. 
+
 ## License
 
 Edirom Online is released to the public under the terms of the [GNU GPL v.3] open source license.