From 0f35cd6a04534d794165ed8f91d4d2e6ba7e2881 Mon Sep 17 00:00:00 2001 From: Nicole Dresselhaus Date: Thu, 15 May 2025 14:55:29 +0200 Subject: [PATCH] fixes #2 --- README.md | 57 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 38 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 42d3d8c..9af5522 100644 --- a/README.md +++ b/README.md @@ -12,29 +12,48 @@ Dinge für etwaige Nachfolger\*innen nicht vergisst. ## 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 -example-project/ -├── README.md -├── INSTALL.md (optional, bei aufwendiger Installation) -├── USAGE.md (optional, bei komplexeren Beispielen oder Workflows) -├── CONTRIBUTING.md (optional, falls Mitarbeit möglich) -├── CITATION.md (oder CITATION.cff) -├── LICENSE -├── CHANGELOG.md (optional) -├── examples/ (optional, Beispielskripte oder Notebooks) -│ └── example_workflow.ipynb -├── data/ (optional, kleine Beispieldaten) -│ └── sample_data.csv -└── src/ - ├── script.py - └── module/ - └── helper.py +. +├── .gitlab (issue-templates für GitLab) +├── CHANGELOG.md (CHANGELOG-Beispiel für Releases) +├── CITATION.md (Wie die Software zitieren?) +├── CONTRIBUTING.md (Wie bei der Software mithelfen?) +├── INSTALL.md (Wie die Software installieren?) +├── README.md (Genereller Überblick) +├── src (Beispielverzeichnis für den eigentlichen Code) +└── USAGE.md (Wie nutze ich die Software?) ``` -Die jeweiligen benötigten Dateien können einfach kopiert werden und enthalten -jeweils eine Anleitung über ihren Inhalt +Die Dateien enthalten 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