Skip to content

Commit 31a6b48

Browse files
committed
Document prerequisites for the GUI
1 parent d55a790 commit 31a6b48

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,6 @@ For more information, refer to the [AVRDUDE documentation](https://avrdudes.gith
6868
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).
6969

7070
The GUI is based on the Qt toolkit and its Python bindings, called _PySide_.
71+
Either Qt5 with PySide2, or Qt6 with PySide6 are supported.
7172

7273
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.

src/python/adgui.bat.in

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1+
rem Wrapper around the AVRDUDE Qt / PySide GUI
2+
rem
3+
rem Prerequisites:
4+
rem * python3
5+
rem * Qt5 / PySide2, or Qt6 / PySide6
16
"@Python3_EXECUTABLE@" "@CMAKE_INSTALL_PREFIX@\@CMAKE_INSTALL_DATADIR@\avrdude\adgui.py"

src/python/adgui.sh.in

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
#!/bin/sh
2+
#
3+
# Wrapper around the AVRDUDE Qt / PySide GUI
4+
#
5+
# Prerequisites:
6+
# * python3
7+
# * Qt5 / PySide2, or Qt6 / PySide6
28

39
if [ ! -d "@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/avrdude" ] ; then
410
echo "Installation directory @CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/avrdude missing" >&2

0 commit comments

Comments
 (0)