Skip to content

Commit 07fbfdc

Browse files
authored
Update README.md
1 parent f3d0720 commit 07fbfdc

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,29 @@ Here some sample screenshots of the gui (The rocket of the information dialog is
3535
- 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 via Qt MaintenanceTool)
3636
- Since the Installer Framework supports Windows, Mac and X11 only, it's the same for this library
3737

38+
## Download/Installation
39+
There are multiple ways to install the Qt module, sorted by preference:
40+
41+
1. Simply add my repository to your Qt MaintenanceTool (Image-based How-To here: [Add custom repository](https://github.com/Skycoder42/QtModules/blob/master/README.md#add-my-repositories-to-qt-maintenancetool)):
42+
1. Open the MaintenanceTool, located in your Qt install directory (e.g. `~/Qt/MaintenanceTool`)
43+
2. Select `Add or remove components` and click on the `Settings` button
44+
3. Go to `Repositories`, scroll to the bottom, select `User defined repositories` and press `Add`
45+
4. In the right column (selected by default), type:
46+
- On Linux: https://install.skycoder42.de/qtmodules/linux_x64
47+
- On Windows: https://install.skycoder42.de/qtmodules/windows_x86
48+
- On Mac: https://install.skycoder42.de/qtmodules/mac_x64
49+
5. Press `Ok`, make shure `Add or remove components` is still selected, and continue the install (`Next >`)
50+
6. A new entry appears under all supported Qt Versions (e.g. `Qt > Qt 5.8 > Skycoder42 Qt modules`)
51+
7. You can install either all of my modules, or select the one you need: `Qt Auto Updater`
52+
8. Continue the setup and thats it! you can now use the module for all of your installed Kits for that Qt Version
53+
2. Download the compiled modules from the release page. **Note:** You will have to add the correct ones yourself and may need to adjust some paths to fit your installation!
54+
3. Build it yourself! **Note:** This requires perl to be installed. If you don't have/need cmake, you can ignore the related warnings. To automatically build and install to your Qt installation, run:
55+
- `qmake`
56+
- `make qmake_all`
57+
- `make`
58+
- `make lrelease` (optional step to generate the .qm files)
59+
- `make install`
60+
3861
## Usage
3962
The autoupdater is provided as a Qt module. Thus, all you have to do is add the module, and then, in your project, add `QT += autoupdatercore` or `QT += autoupdatergui` to your .pro file - depending on what you need!
4063

@@ -110,29 +133,6 @@ int main(int argc, char *argv[])
110133
}
111134
```
112135

113-
## Download/Installation
114-
There are multiple ways to install the Qt module, sorted by preference:
115-
116-
1. Simply add my repository to your Qt MaintenanceTool (Image-based How-To here: [Add custom repository](https://github.com/Skycoder42/QtModules/blob/master/README.md#add-my-repositories-to-qt-maintenancetool)):
117-
1. Open the MaintenanceTool, located in your Qt install directory (e.g. `~/Qt/MaintenanceTool`)
118-
2. Select `Add or remove components` and click on the `Settings` button
119-
3. Go to `Repositories`, scroll to the bottom, select `User defined repositories` and press `Add`
120-
4. In the right column (selected by default), type:
121-
- On Linux: https://install.skycoder42.de/qtmodules/linux_x64
122-
- On Windows: https://install.skycoder42.de/qtmodules/windows_x86
123-
- On Mac: https://install.skycoder42.de/qtmodules/mac_x64
124-
5. Press `Ok`, make shure `Add or remove components` is still selected, and continue the install (`Next >`)
125-
6. A new entry appears under all supported Qt Versions (e.g. `Qt > Qt 5.8 > Skycoder42 Qt modules`)
126-
7. You can install either all of my modules, or select the one you need: `Qt Auto Updater`
127-
8. Continue the setup and thats it! you can now use the module for all of your installed Kits for that Qt Version
128-
2. Download the compiled modules from the release page. **Note:** You will have to add the correct ones yourself and may need to adjust some paths to fit your installation!
129-
3. Build it yourself! **Note:** This requires perl to be installed. If you don't have/need cmake, you can ignore the related warnings. To automatically build and install to your Qt installation, run:
130-
- `qmake`
131-
- `make qmake_all`
132-
- `make`
133-
- `make lrelease` (optional step to generate the .qm files)
134-
- `make install`
135-
136136
## Documentation
137137
The documentation is available on [github pages](https://skycoder42.github.io/QtAutoUpdater/). It was created using [doxygen](http://www.doxygen.org/). The HTML-documentation and Qt-Help files are shipped
138138
together with the module for both the custom repository and the package on the release page. Please note that doxygen docs do not perfectly integrate with QtCreator/QtAssistant.

0 commit comments

Comments
 (0)