Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lionelsemion committed Jan 28, 2025
1 parent a4e86d5 commit 17948e2
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

## Einführung

In diesem Projekt werden die Unterlagen für den Grundkurs Programmieren der Universität Bern verwaltet. Diese sind Semester unabhängig, sprich alle Ordner, und dementsprechend Verlinkungen, haben den Aufbau WEEK_XX. Beim Erstellen der Semester Unterlagen (siehe nächster Punkt) werden diese mit den tatsächlichen Wochen des Semesters ersetzt. Weiter werden alle Musterlöschen entfernt.
In diesem Projekt werden die Unterlagen für den Grundkurs Programmieren der Universität Bern verwaltet. Diese sind Semester unabhängig, sprich alle Ordner, und dementsprechend Verlinkungen, haben den Aufbau WEEK_XX. Beim Erstellen der Semester Unterlagen (siehe nächster Punkt) werden diese mit den tatsächlichen Wochen des Semesters ersetzt. Weiter werden alle Musterlöschen entfernt.

## Semester Unterlagen erstellen

Um die Unterlagen für das aktuelle Semester zu erstellen müssen folgende Schritte durchgeführt werden:
Um die Unterlagen für das aktuelle Semester zu erstellen müssen folgende Schritte durchgeführt werden:

1. Unter folgendem [Link](https://github.com/grundkurs-programmieren/unterlagen/settings/variables/actions) muss eine JSON Datei hinterlegt werden für das Mapping WEEK_XX -> DD.MM.YYYY mit dem Namen `SEMESTER_WEEKS_XX`
2. Unter folgendem [Link](https://github.com/grundkurs-programmieren/unterlagen/actions/workflows/create-student-version.yml) kann ein neuer Workflow gestartet werden (Run Workflow)
3. Der abgeschlossene Workflow generiert/überschreibt den Ordner student_versions/{SEMESTER} mit den Unterlagen für das aktuelle Semester.
<br> Zusätzlich generiert der Workflow drei verschiedene Artefakte, die auch die Unterlagen für das Semester beinhalten.
<br> Zusätzlich generiert der Workflow drei verschiedene Artefakte, die auch die Unterlagen für das Semester beinhalten.

## Arbeiten mit dem Projekt

Expand All @@ -21,12 +21,11 @@ Starten Sie eine neue Session. Denken Sie daran am Ende der Session Ihre Arbeit

### Lokal

Sollten Sie **lokal** an den Unterlagen arbeiten, dann führen Sie vor dem ersten Git Commit **unbedingt** folgende zwei Zeilen aus:
Sollten Sie **lokal** an den Unterlagen arbeiten, dann führen Sie vor dem ersten Git Commit **unbedingt** folgenden Befehl aus:

```bash
chmod u+x git_configure.sh
./git_configure.sh
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --to=notebook --stdin --stdout --log-level=INFO
```

Damit wird sichergestellt, dass die Output Zellen der Notebooks nicht in unserem Repository landen.
Damit wird sichergestellt, dass die Output Zellen der Notebooks nicht in unserem Repository landen.
Mehr Informationen finden Sie [hier](https://stackoverflow.com/a/64513642).

0 comments on commit 17948e2

Please sign in to comment.