added readme, added license

This commit is contained in:
2026-02-12 15:59:03 +01:00
parent 5dbb792f9d
commit 1ce0d0f762
3 changed files with 94 additions and 1 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 Nils Pukropp
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

72
README.md Normal file
View File

@@ -0,0 +1,72 @@
# Mathematik 2 für Informatiker - Merkblatt (WS 2026)
Dieses Repository enthält eine [Typst](https://typst.app/)-Vorlage für ein Merkblatt zur Vorlesung **Mathematik 2 für Informatiker** an der **Albert-Ludwigs-Universität Freiburg**.
> [!IMPORTANT]
> **Wichtiger Hinweis zur Klausur:** In der Klausur ist ein Merkblatt erlaubt, dieses **muss jedoch zwingend handschriftlich** verfasst sein. Diese digitale Vorlage dient lediglich zur Strukturierung, Zusammenfassung und als Lernhilfe. Sie darf **nicht** direkt in der Klausur verwendet werden.
## Features
- **Themen:** Umfassende Zusammenfassung der Vorlesungsinhalte des WS 2026.
- **Layout:** Optimiertes A4-Querformat mit effizienter Platznutzung.
- **Modi:** Unterstützung für **Dark Mode** und **Light Mode**.
- **Technologie:** Erstellt mit Typst für ein sauberes, mathematisches Satzbild.
## Voraussetzungen
Um das Merkblatt lokal zu bauen, muss **Typst** auf deinem System installiert sein.
- **Installation:** Folge den Anweisungen auf [typst.app](https://github.com/typst/typst?tab=readme-ov-file#installation).
- **VS Code Erweiterung:** Empfohlen wird die Erweiterung `Typst LSP` für Syntax-Highlighting und Live-Vorschau.
## Build-Anleitung
Das Repository enthält ein `build.sh` Skript, welches automatisch sowohl eine Dark-Mode als auch eine Light-Mode Version im Ordner `build/` erstellt.
### Mit dem Build-Skript (Linux/macOS)
1. Mache das Skript ausführbar (falls nötig):
```bash
chmod +x build.sh
```
2. Starte den Build-Prozess:
```bash
./build.sh
```
### Manuelle Kompilierung
Du kannst Typst auch direkt über das Terminal aufrufen:
**Light Mode (Empfohlen für den Ausdruck zum Abschreiben):**
```bash
typst compile --input dark-mode=false src/mathe_2_merkblatt.typ build/merkblatt_light.pdf
```
**Dark Mode:**
```bash
typst compile --input dark-mode=true src/mathe_2_merkblatt.typ build/merkblatt_dark.pdf
```
## Projektstruktur
- `src/`: Enthält die `.typ` Quelldatei.
- `build/`: Hier werden die generierten PDF-Dateien gespeichert.
- `build.sh`: Automatisierungsskript für die Kompilierung.
## Beitrag & Kontakt
Du hast Fehler gefunden oder die Vorlage für das aktuelle Semester aktualisiert? Ich freue mich über jede Verbesserung! Schick mir gerne eine aktualisierte Version oder kontaktiere mich bei Fragen:
- **E-Mail:** [nils@narl.io](mailto:nils@narl.io)
- **Git:** [git.narl.io/nvrl/Mathe-II-Informatik-Merkblatt](https://git.narl.io/nvrl/Mathe-II-Informatik-Merkblatt)
## Lizenz
Dieses Projekt ist unter der **MIT-Lizenz** lizenziert. Das bedeutet, du kannst die Vorlage beliebig kopieren, verändern und weiterverbreiten. Beachte jedoch, dass die Software "wie besehen" bereitgestellt wird, ohne jegliche Gewährleistung. Siehe die Datei [LICENSE](LICENSE) für Details.
## Autor
**Nils Pukropp**
Email: [nils@narl.io](mailto:nils@narl.io)
Repository: [GitHub / Git Narl](https://git.narl.io/nvrl/Mathe-II-Informatik-Merkblatt)

View File

@@ -47,7 +47,7 @@
[
#link("mailto:nils@narl.io") #h(1em) | #h(1em)
#link("https://git.narl.io/nvrl/Mathe-II-f-r-Informatiker-Merkblatt")[#underline[https://git.narl.io/nvrl/Mathe-II-f-r-Informatiker-Merkblatt]]
#link("https://git.narl.io/nvrl/Mathe-II-Informatik-Merkblatt")[#underline[https://git.narl.io/nvrl/Mathe-II-Informatik-Merkblatt]]
],
[Stand: WS2026]
)