Drezil/doc_documentation
1
0
Fork 0
mirror of https://scm.cms.hu-berlin.de/methodenlabor/doc_documentation.git synced 2025-06-08 01:49:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

added yaml header where appropiate, added bibtex-example to CITATION

Browse Source
This commit is contained in:
Nicole Dresselhaus 2025-05-14 17:31:58 +02:00
parent 1d5dc729fd
commit 5172700f0b
3 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
example-project/CITATION.md
View File

@ -6,4 +6,14 @@ Nenne hier die bevorzugte Zitierweise für Publikationen oder DOI:
Nachname, Vorname. (Jahr). Projektname (Version X.Y.Z). DOI oder URL.
```
```bibtex
@software{bibtex-key,
author = {{}},
title = {Projektname},
url = {Projekthomepage},
version = {version},
date = {datum versions-release},
}
```
- **Keine langen Beschreibungen**, nur den Zitierhinweis.

4
example-project/INSTALL.md
View File

@ -1,3 +1,7 @@
---
date: 2025-05-14 # when was this touched last?
---
# Installation
Ausführliche Schritt-für-Schritt Anleitung zur Installation.

6
example-project/USAGE.md
View File

@ -1,4 +1,8 @@
# Nutzung der Software
---
title: "Nutzung der Software"
date: 2025-05-14 # zuletzt angepasst
version: v1.0 # Auf welche Version bezieht sich dies?
---
Ausführliche Beschreibung typischer Workflows oder Beispielanwendungen.