diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 27ec71e..d927b51 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,7 +34,7 @@ jobs: powershell -Command Compress-Archive dist/epson_print_conf.exe dist/epson_print_conf.zip - name: Generate Changelog - run: echo "The executable file in the assets below is auto-generated by a GitHub Action." > ${{ github.workspace }}-CHANGELOG.txt + run: echo "The executable file in the epson_print_conf.zip archive within the assets below is auto-generated by a [GitHub Action](.github/workflows/build.yml)." > ${{ github.workspace }}-CHANGELOG.txt - name: Create Release uses: softprops/action-gh-release@v2 diff --git a/README.md b/README.md index e483666..e47ef3d 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,14 @@ It is tested with Ubuntu / Windows Subsystem for Linux, Windows. ## Usage +### Running the pre-built GUI executable code + +The *epson_print_conf.zip* archive in the [Releases](releases) folder incudes the *epson_print_conf.exe* executable file; the ZIP archive is auto-generated by a [GitHub Action](.github/workflows/build.yml). *epson_print_conf.exe* is a Windows GUI that can be directly executed. + ### Running the GUI with Python +Run *ui.py* as in this example: + ``` python ui.py ``` @@ -196,6 +202,8 @@ pyinstaller epson_print_conf.spec When the build operation is completed, you can run the *epson_print_conf.exe* file created in the *dist/* folder. This executable program does not have options, embeds the *printer_conf.pickle* file and starts with the default IP address and printer model defined in the build phase. +The executable file is automatically generated by a [GitHub Action](.github/workflows/build.yml). It is included in a ZIP file named *epson_print_conf.zip* and uploaded into the [Releases](releases) folder. + ## Utilities and notes ### parse_devices.py