diff --git a/README.md b/README.md index 55601d88..5860e775 100644 --- a/README.md +++ b/README.md @@ -68,5 +68,6 @@ For more information, refer to the [AVRDUDE documentation](https://avrdudes.gith Starting with version 8, a GUI implementation has been added, to demonstrate the functionality of `libavrdude` is suitable to implement a native GUI (as opposed to CLI wrapper). The GUI is based on the Qt toolkit and its Python bindings, called _PySide_. +Either Qt5 with PySide2, or Qt6 with PySide6 are supported. A script named `avrdude-gui` is installed into the same location as the AVRDUDE CLI program. It can be used to start the GUI. There is a builtin help describing the usage. diff --git a/src/python/adgui.bat.in b/src/python/adgui.bat.in index f7f44dbe..de6b52a2 100644 --- a/src/python/adgui.bat.in +++ b/src/python/adgui.bat.in @@ -1 +1,6 @@ +rem Wrapper around the AVRDUDE Qt / PySide GUI +rem +rem Prerequisites: +rem * python3 +rem * Qt5 / PySide2, or Qt6 / PySide6 "@Python3_EXECUTABLE@" "@CMAKE_INSTALL_PREFIX@\@CMAKE_INSTALL_DATADIR@\avrdude\adgui.py" diff --git a/src/python/adgui.sh.in b/src/python/adgui.sh.in index 4a56dfc9..8030155a 100644 --- a/src/python/adgui.sh.in +++ b/src/python/adgui.sh.in @@ -1,4 +1,10 @@ #!/bin/sh +# +# Wrapper around the AVRDUDE Qt / PySide GUI +# +# Prerequisites: +# * python3 +# * Qt5 / PySide2, or Qt6 / PySide6 if [ ! -d "@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/avrdude" ] ; then echo "Installation directory @CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/avrdude missing" >&2