doc(README): add a minimal readme file

2026-08-25 11:36:00 +02:00
parent 40474c071e
commit e7c93eec75
1 changed files with 28 additions and 1 deletions
@@ -1,3 +1,30 @@
 # helioviewer_grab

-Fetches an image from the helioviewer api at a given time
+Kleines Skript, das ein Sonnen-Vollscheibenbild von [Helioviewer](https://helioviewer.org)
+zu einem gewünschten Zeitpunkt herunterlädt.
+
+Es sucht in der Helioviewer-API die Datenquelle passend zum angegebenen
+Stichwort (z.B. `hmi_continuum`), holt das dem Zeitpunkt am nächsten liegende
+Bild und speichert es als PNG im aktuellen Verzeichnis.
+
+## Nutzung
+
+```bash
+./helioviewer_grab.py 2026-08-12T18:18:00Z hmi_continuum
+./helioviewer_grab.py --list # verfügbare Datenquellen anzeigen
+```
+
+Ohne Argumente werden Beispielwerte verwendet (siehe Docstring im Skript).
+
+## Requirements
+
+Nur die Python-Standardbibliothek, keine Dependencies.
+Mit [devenv](https://devenv.sh) steht der passende Interpreter direkt bereit:
+
+```bash
+devenv shell
+```
+
+## Author
+
+Aaron Schmocker <aaron@0x29a.ch>