docs: rewrite README and docs to concise ASCII style
This commit is contained in:
52
README.md
52
README.md
@@ -2,41 +2,37 @@
|
||||
|
||||
<img src="addon/resources/logo.png" alt="ViewIT Logo" width="220" />
|
||||
|
||||
ViewIT ist ein Kodi‑Addon zum Durchsuchen und Abspielen von Inhalten der unterstützten Anbieter.
|
||||
ViewIT ist ein Kodi Addon.
|
||||
Es durchsucht Provider und startet Streams.
|
||||
|
||||
## Projektstruktur
|
||||
- `addon/` Kodi‑Addon Quellcode
|
||||
- `scripts/` Build‑Scripts (arbeiten mit `addon/` + `dist/`)
|
||||
- `dist/` Build‑Ausgaben (ZIPs)
|
||||
- `docs/`, `tests/`
|
||||
- `addon/` Kodi Addon Quellcode
|
||||
- `scripts/` Build Scripts
|
||||
- `dist/` Build Ausgaben
|
||||
- `docs/` Doku
|
||||
- `tests/` Tests
|
||||
|
||||
## Build & Release
|
||||
- Addon‑Ordner bauen: `./scripts/build_install_addon.sh` → `dist/<addon_id>/`
|
||||
- Kodi‑ZIP bauen: `./scripts/build_kodi_zip.sh` → `dist/<addon_id>-<version>.zip`
|
||||
- Addon‑Version in `addon/addon.xml`
|
||||
- Reproduzierbare ZIPs: optional `SOURCE_DATE_EPOCH` setzen
|
||||
## Build und Release
|
||||
- Addon Ordner bauen: `./scripts/build_install_addon.sh`
|
||||
- Kodi ZIP bauen: `./scripts/build_kodi_zip.sh`
|
||||
- Version pflegen: `addon/addon.xml`
|
||||
- Reproduzierbares ZIP: `SOURCE_DATE_EPOCH` optional setzen
|
||||
|
||||
## Lokales Kodi-Repository
|
||||
- Repository bauen (inkl. ZIPs + `addons.xml` + `addons.xml.md5`): `./scripts/build_local_kodi_repo.sh`
|
||||
- Lokal bereitstellen: `./scripts/serve_local_kodi_repo.sh`
|
||||
- Standard-URL: `http://127.0.0.1:8080/repo/addons.xml`
|
||||
- Optional eigene URL beim Build setzen: `REPO_BASE_URL=http://<host>:<port>/repo ./scripts/build_local_kodi_repo.sh`
|
||||
## Lokales Kodi Repository
|
||||
- Repository bauen: `./scripts/build_local_kodi_repo.sh`
|
||||
- Repository starten: `./scripts/serve_local_kodi_repo.sh`
|
||||
- Standard URL: `http://127.0.0.1:8080/repo/addons.xml`
|
||||
- Eigene URL beim Build: `REPO_BASE_URL=http://<host>:<port>/repo ./scripts/build_local_kodi_repo.sh`
|
||||
|
||||
## Gitea Release-Asset Upload
|
||||
- ZIP bauen: `./scripts/build_kodi_zip.sh`
|
||||
- Token setzen: `export GITEA_TOKEN=<token>`
|
||||
- Asset an Tag hochladen (erstellt Release bei Bedarf): `./scripts/publish_gitea_release.sh`
|
||||
- Optional: `--tag v0.1.50 --asset dist/plugin.video.viewit-0.1.50.zip`
|
||||
|
||||
## Entwicklung (kurz)
|
||||
- Hauptlogik: `addon/default.py`
|
||||
## Entwicklung
|
||||
- Router: `addon/default.py`
|
||||
- Plugins: `addon/plugins/*_plugin.py`
|
||||
- Einstellungen: `addon/resources/settings.xml`
|
||||
- Settings: `addon/resources/settings.xml`
|
||||
|
||||
## Tests mit Abdeckung
|
||||
- Dev-Abhängigkeiten installieren: `./.venv/bin/pip install -r requirements-dev.txt`
|
||||
- Tests + Coverage starten: `./.venv/bin/pytest`
|
||||
- Optional (XML-Report): `./.venv/bin/pytest --cov-report=xml`
|
||||
## Tests
|
||||
- Dev Pakete installieren: `./.venv/bin/pip install -r requirements-dev.txt`
|
||||
- Tests starten: `./.venv/bin/pytest`
|
||||
- XML Report: `./.venv/bin/pytest --cov-report=xml`
|
||||
|
||||
## Dokumentation
|
||||
Siehe `docs/`.
|
||||
|
||||
Reference in New Issue
Block a user