feat(docs): migrate to zensical, re-structure docs
This commit is contained in:
85
docs/allgemein/installation.md
Normal file
85
docs/allgemein/installation.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Installation
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
Bevor Sie den SemesterapparatsManager installieren können, stellen Sie sicher, dass folgende Voraussetzungen erfüllt sind:
|
||||
|
||||
- [x] Windows 10/11 oder höher
|
||||
- [x] Internetzugang für Katalog-Abfragen
|
||||
- [x] Optional: Zotero-Account für ELSA-Funktionen
|
||||
|
||||
## Installation
|
||||
|
||||
### Für Endanwender
|
||||
|
||||
=== "Portable Version"
|
||||
|
||||
1. Laden Sie die neueste Version von der Release-Seite herunter
|
||||
2. Entpacken Sie die ZIP-Datei in einen Ordner Ihrer Wahl
|
||||
3. Starten Sie `SemesterapparatsManager.exe`
|
||||
|
||||
=== "Installer"
|
||||
|
||||
1. Laden Sie den Installer herunter
|
||||
2. Führen Sie die Setup-Datei aus
|
||||
3. Folgen Sie den Anweisungen des Installationsassistenten
|
||||
4. Starten Sie das Programm über das Startmenü
|
||||
|
||||
### Für Entwickler
|
||||
|
||||
!!! note "Entwicklerinstallation"
|
||||
Diese Anleitung ist für Entwickler gedacht, die den Quellcode bearbeiten möchten.
|
||||
|
||||
#### Mit UV (empfohlen)
|
||||
|
||||
```bash
|
||||
# Repository klonen
|
||||
git clone https://github.com/IHR-REPO/SemesterapparatsManager.git
|
||||
cd SemesterapparatsManager
|
||||
|
||||
# Virtuelle Umgebung erstellen und Abhängigkeiten installieren
|
||||
uv sync
|
||||
|
||||
# Anwendung starten
|
||||
uv run python main.py
|
||||
```
|
||||
|
||||
#### Mit pip
|
||||
|
||||
```bash
|
||||
# Repository klonen
|
||||
git clone https://github.com/IHR-REPO/SemesterapparatsManager.git
|
||||
cd SemesterapparatsManager
|
||||
|
||||
# Virtuelle Umgebung erstellen
|
||||
python -m venv .venv
|
||||
.venv\Scripts\activate
|
||||
|
||||
# Abhängigkeiten installieren
|
||||
pip install -e ".[dev]"
|
||||
|
||||
# Anwendung starten
|
||||
python main.py
|
||||
```
|
||||
|
||||
## Erster Start
|
||||
|
||||
Beim ersten Start werden Sie aufgefordert, sich anzumelden:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
!!! tip "Tipp"
|
||||
Ihre Anmeldedaten werden sicher gespeichert. Bei Fragen zur Einrichtung wenden Sie sich an den Administrator.
|
||||
|
||||
## Konfiguration
|
||||
|
||||
Nach der Installation sollten Sie die Einstellungen überprüfen:
|
||||
|
||||
1. Öffnen Sie das Programm
|
||||
2. Gehen Sie zu **Einstellungen** (über das Menü oder :lucide-settings:)
|
||||
3. Konfigurieren Sie:
|
||||
- **Datenbank-Pfad**: Speicherort der SQLite-Datenbank
|
||||
- **Zotero**: API-Schlüssel für Zitat-Funktionen
|
||||
- **E-Mail**: SMTP-Einstellungen für Benachrichtigungen
|
||||
|
||||
Weitere Informationen zur Konfiguration finden Sie unter [Hauptoberfläche](hauptoberflaeche.md).
|
||||
Reference in New Issue
Block a user