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

fixes #2

Browse Source
This commit is contained in:
Nicole Dresselhaus 2025-05-15 14:55:29 +02:00
parent 3cb8457bc8
commit 0f35cd6a04
1 changed files with 38 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -12,29 +12,48 @@ Dinge für etwaige Nachfolger\*innen nicht vergisst.
## Nutzung ## Nutzung
Das Unterverzeichnis `example-project` enthält folgende Struktur: Wir haben GitLab-Templates, die man benutzen kann, wenn man ein Projekt startet.
Falls bereits Code oder ein Repository besteht, ist es am Besten, wenn man
dennoch im GitLab ein neues Projekt mit diesem Template erstellt und
anschließend die existierenden Dateien herüberkopiert.
### Code-Project
Das
[Code-Project-Template](https://scm.cms.hu-berlin.de/methodenlabor/templates/code-project-template)
ist für Repositories gedacht, die irgendeine Art von Verarbeitung haben, bei der
primär Daten analysiert, weiterverarbeitet oder ausgewertet werden ODER es sich
um ein Applikationsprojekt im klassischen Sinne handelt.
Ziel ist hier die Entwicklung und langfristig die Installation,
Veröffentlichung,Nutzung und Wartung der Software.
Das Template enthält folgende Struktur:
```plain ```plain
example-project/ .
├── README.md ├── .gitlab (issue-templates für GitLab)
├── INSTALL.md (optional, bei aufwendiger Installation) ├── CHANGELOG.md (CHANGELOG-Beispiel für Releases)
├── USAGE.md (optional, bei komplexeren Beispielen oder Workflows) ├── CITATION.md (Wie die Software zitieren?)
├── CONTRIBUTING.md (optional, falls Mitarbeit möglich) ├── CONTRIBUTING.md (Wie bei der Software mithelfen?)
├── CITATION.md (oder CITATION.cff) ├── INSTALL.md (Wie die Software installieren?)
├── LICENSE ├── README.md (Genereller Überblick)
├── CHANGELOG.md (optional) ├── src (Beispielverzeichnis für den eigentlichen Code)
├── examples/ (optional, Beispielskripte oder Notebooks) └── USAGE.md (Wie nutze ich die Software?)
│ └── example_workflow.ipynb
├── data/ (optional, kleine Beispieldaten)
│ └── sample_data.csv
└── src/
├── script.py
└── module/
└── helper.py
``` ```
Die jeweiligen benötigten Dateien können einfach kopiert werden und enthalten Die Dateien enthalten jeweils eine Anleitung über ihren Inhalt
jeweils eine Anleitung über ihren Inhalt
### Daten-Project
**Ein ähnliches Projekt für Daten-Repositories ist in Planung.**
Das Template ist für Repositories gedacht, die Daten aus Quellen erstellen,
aufbereiten und wieder zur Verfügung stellen. Beispiele wären z.b. Bilder ~>
annotierter Korpus.
Ziel ist hier die Dokumentation und die Reproduzierbarkeit von
`Quelle -> Datensatz`.
## Wissenschaftlicher Hintergrund ## Wissenschaftlicher Hintergrund