diff --git a/README.md b/README.md index c03fa4d1..365bf927 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,22 @@ Automatisierte Impfterminbuchung auf [www.impfterminservice.de](https://www.impf ## Downloads -> ⚠️ Google Chrome muss auf dem PC installiert sein (Windows, Mac und Linux) +> ⚠️ Google Chrome muss auf dem PC installiert sein (Windows, Mac und Linux) +Download neuste Version: -[Lade die neuste Version der Anwendung runter](https://github.com/iamnotturner/vaccipy/releases/latest) + + + + + +

-#### BETA Version -Der BETA-Branch enthält neue, noch nicht final getestete Features. [Sollten Fehler auftreten könnt ihr hier ein Issue erstellen.](https://github.com/iamnotturner/vaccipy/issues) +#### BETA Version +Der BETA-Branch enthält neue, noch nicht final getestete Features. [Sollten Fehler auftreten könnt ihr hier ein Issue erstellen.](https://github.com/iamnotturner/vaccipy/issues) +Download Beta: @@ -39,6 +46,9 @@ Der BETA-Branch enthält neue, noch nicht final getestete Features. [Sollten Feh +## Releases +[Link zum neusten Release](https://github.com/iamnotturner/vaccipy/releases/latest) +Mehr Informationen, wie die Releases funktionieren findest du [hier](https://github.com/iamnotturner/vaccipy/blob/master/docs/distribution.md). ## Ausgangssituation @@ -262,7 +272,6 @@ werden (von uns oder euch - feel free!) irgendwann hinzukommen: - [ ] Github Pages - [ ] Macosx Build / Pipeline (Mac currently blocks the app: [Branch](https://github.com/iamnotturner/vaccipy/tree/mac-intel-build)) - [ ] Code Zertifikate für Windows (gegen Virusmeldung) -- [x] Artifacts, Packages und Releases ## Das kann vaccipy NICHT - und wird es auch nie können diff --git a/docs/distribution.md b/docs/distribution.md index 97815b69..6e73aa53 100644 --- a/docs/distribution.md +++ b/docs/distribution.md @@ -1,36 +1,40 @@ ## Distributionen -Für eine bessere Nutzererfahrung erstellen wir verschiedene Distributionen, die ohne installation von Python direkt ausgeführt werden können. -Die Unterfolder von `dist/` sind jeweils Distributionen die geteilt werden können und eigenständig funktionieren. +Für eine bessere Nutzererfahrung erstellen wir verschiedene Distributionen, die ohne installation von Python direkt ausgeführt werden können. +Diese sind im Abschnitt `assets` des [neusten Release](https://github.com/iamnotturner/vaccipy/releases/latest +) zu finden. -Zum Ausführen des Programms, einfach die passende Distribution (basierend auf dem eigenen Betriebssysstem) auswählen und die folgende Datei ausführen. - -*Hinweis: Es wird jeweils immer der gesamte Ordner benötigt!* ### Download Verfügbare Distributionen: -- [x] [Windows](https://cntr.click/9ypzBLb) -- [x] [Linux](https://cntr.click/6Q0PXkK) +- [x] [Windows](https://cntr.click/rS9Ds4R) +- [x] [Linux](https://cntr.click/mN1MPzc) - [ ] MacOS Intel - [ ] MacOS M1 **Ausführung Windows:** -- .zip Ordner entpacken -- Im `windows-terminservice\`-Ordner die `windows-terminservice.exe` ausführen. +- installer ausführen +- vaccipy installieren +- vaccipy ausführen +- (INFO: Vaccipy kann später auch wieder deinstalliert werden) + +Für mehr Info zum Verteilen und Erstellen der Distributionen: [Shipping und Releases](#Shipping-und-releases) + +## Shipping und Releases +### Workflows -Für mehr Info zum Verteilen und Erstellen der Distributionen: [Shipping](#Shipping) +Es gibt aktuell zwei aktive Worklflows: +* der [Build Workflow](https://github.com/iamnotturner/vaccipy/actions/workflows/build.yaml) wird bei jedem push gestartet und überprüft ob die aktuellen Änderungen auch in ein Build gebaut werden können. +* der [Deploy Workflow](https://github.com/iamnotturner/vaccipy/actions/workflows/deploy.yaml) wird bei jedem push eines [Tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) gestartet und erstellt ein neues Build sowie ein neues Release dazu. +
-### Shipping -#### Workflows -Um den Buildprozess zu vereinfachen gibt es verschiedene Buildpipelines, welche bei push Events in den Masterbranch ausgeführt werden. -Die pipelines sind im `.github/workflows` Ordner zu finden. +### Wie werden Releases erstellt ? -Aktuelle Pipelines: -- [x] [Windows Build-Pipeline](https://github.com/iamnotturner/vaccipy/actions/workflows/build_windows.yaml) -- [x] [Linux 64 Build-Pipeline](https://github.com/iamnotturner/vaccipy/actions/workflows/build_linux.yaml) +Um ein neues Release zu erstellen, muss ein neues Tag (dessen Name mit `v` starten bsp. `v0.1`) zu dem neuesten Stand (Commit) erst hinzugefügt und dann gepushed werden. Das startet den [Deploy Workflow](https://github.com/iamnotturner/vaccipy/actions/workflows/deploy.yaml). +
-#### Generell +### Wie werden Distributionen erstellt ? Zum Erstellen der Distributionen wird [pyinstaller](https://pyinstaller.readthedocs.io/en/stable/index.html) verwendet. Schritte zum Erstellen einer Distribution: @@ -60,5 +64,12 @@ pyinstaller --clean specs/linux-64-terminservice.spec ``` +### Windows Installer +Für den Windows installer wird aktuell [Inno Setup](https://jrsoftware.org/isinfo.php) verwendet. +Im [Deploy Workflow](https://github.com/iamnotturner/vaccipy/actions/workflows/deploy.yaml) führt der Inno Setup Compiler das `windows-terminservice.iss` Script aus, welches die zuvor von Pyinstaller gebaute Distribution, in einen Installer packt. + +**Tipp:** Zum erstellen und bearbeiten des .iss Scripts empfiehlt sich der `Inno Script Studio script editor` welcher im [QuickStart Pack](https://jrsoftware.org/download.php/ispack.exe) vorhanden ist. + #### Resources - [pyinstaller docs](https://pyinstaller.readthedocs.io/en/stable/index.html) +- [Inno Setup](https://jrsoftware.org/isinfo.php)