Skip to content

Commit da577b5

Browse files
committed
Update README.md
1 parent 5c372b0 commit da577b5

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Github repository: https://github.com/Skycoder42/QtAutoUpdater
2929
- UpdatePanel -> a button with a busy-indicator to to the same
3030

3131
#### Screenshots
32-
Here some sample screenshots of the gui
32+
Here some sample screenshots of the gui (The rocket of the information dialog is the "application icon" and depends on your application)
3333

3434
| Dialog Sample | Windows | Mac | X11 |
3535
|--------------------|-------------------------------------------|-------------------------------------------|-------------------------------------------|
@@ -43,7 +43,11 @@ Here some sample screenshots of the gui
4343
- C++11 - The library makes heavy use of it's features
4444
- Qt 5.5 (the minimum I tested, may work with older versions)
4545
- If you are using Qt 5.6, the updater will make use of the new QVersionNumber class. If not, it will create a class named the same way that simply inherits QString and adds a few functions.
46-
- Since the Installer Framework supports Windows, Mac and X11 only, it's the same for this library
46+
- Since the Installer Framework supports Windows, Mac and X11 only, it's the same for this library
47+
48+
## Getting started
49+
The usage of this library is not that complicated. However, to make this work you will have to use the Qt Installer Framework to create and installer/updater. If you already now how to to that, just check out the examples below. If not, you can check out my
50+
[Tutorial: Create a simple auto-updated application]()
4751

4852
## Examples
4953
**Important:**<br>
@@ -118,16 +122,16 @@ The documentation was created using [doxygen](http://www.stack.nl/~dimitri/doxyg
118122

119123
## Downloads
120124
Downloads are available via [github releases](https://github.com/Skycoder42/QtAutoUpdater/releases). The downloads include:
121-
- A .pri file for easy project includes (Just add `include(<path_to>/qtautoupdater.pri)` to your project!)
125+
- A .pri file for easy project includes (Just add `include(<path_to>/qtautoupdater.pri)` to your project and all the includes/libray imports/... will be done by that file!)
122126
- Qt5.5.1 precompiled binaries for:
123127
- Windows
124128
- msvc2013 x86
125129
- msvc2013 x64
126130
- mingw
127-
- X11 (Linux)
128-
- gcc x64
129131
- OsX
130132
- clang x64
133+
- X11 (Linux)
134+
- gcc x64
131135
- The (public) header files needed for these binaries
132136
- The HTML and QtHelp documentation
133137
- The (undeployed) widgets example

0 commit comments

Comments
 (0)