Skip to content

Commit 1bc8ad6

Browse files
committed
Update README.md
1 parent b2efe30 commit 1bc8ad6

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A library to automatically check for updates and install them. This repository i
55
- A second library that requires the first one and adds basic GUI features
66

77
## Main Features
8-
#### Core Library
8+
### Core Library
99
- Automatic Check for updates using the maintenancetool
1010
- Can automatically run the maintenancetool after the application finished
1111
- To run as admin/root, either use the GUI or implement it yourself (via an interface)
@@ -17,7 +17,7 @@ A library to automatically check for updates and install them. This repository i
1717
- Supports custom Schedule-types (via an interface)
1818
- can store unfinished tasks and complete them the next time the application runs, if they are valid
1919

20-
#### GUI Library
20+
### GUI Library
2121
- Requires Widgets (no direct QML-support, and I'm not intending to create one. If you want to use the updater in QML, do the connection yourself!)
2222
- Automated controller to guide the user through the check-for-updates process
2323
- customizable: you can decide what to show
@@ -26,6 +26,16 @@ A library to automatically check for updates and install them. This repository i
2626
- UpdateAction -> a QAction that starts the updater
2727
- UpdatePanel -> a button with a busy-indicator to to the same
2828

29+
#### Screenshots
30+
Here some sample screenshots of the gui
31+
32+
| Dialog Sample | Windows | Mac | X11 |
33+
|--------------------|-------------------------------------------|-------------------------------------------|-------------------------------------------|
34+
| Progress Dialog | ![](./doc/images/win/dialog_progress.png) | ![](./doc/images/mac/dialog_progress.png) | ![](./doc/images/x11/dialog_progress.png) |
35+
| Information Dialog | ![](./doc/images/win/dialog_info.png) | ![](./doc/images/mac/dialog_info.png) | ![](./doc/images/x11/dialog_info.png) |
36+
| Update Panel | ![](./doc/images/win/panel_checking.png) | ![](./doc/images/mac/panel_checking.png) | ![](./doc/images/x11/panel_checking.png) |
37+
| Update Action | ![](./doc/images/win/action.png) | ![](./doc/images/mac/action.png) | ![](./doc/images/x11/action.png) |
38+
2939
## Requirements
3040
- Qt Installer Framework: The updater requires the application to be installed using the framework and will use the frameworks update mechanism to check for updates (https://doc.qt.io/qtinstallerframework/, download at https://download.qt.io/official_releases/qt-installer-framework/)
3141
- C++11 - The library makes heavy use of it's features

0 commit comments

Comments
 (0)