sigrok-cross-mingw: README: Reduce Qt5 dependencies.
[sigrok-util.git] / cross-compile / appimage / README
1 -------------------------------------------------------------------------------
2 README
3 -------------------------------------------------------------------------------
4
5 This is a small script for bundling PulseView and its dependencies
6 for Linux systems as an AppImage.
7
8 AppImage is a bundle format for Linux applications that allows the user to 
9 download an application, make it executable, and run.
10 No need to install. No system libraries or system preferences are altered.
11
12 For more information on AppImage, please see
13 http://appimage.org/
14
15 For example AppImages, please see
16 https://github.com/probonopd/AppImages
17
18
19 Status
20 ------
21
22 Work in progress.
23
24
25 Requirements
26 ------------
27
28 Currently the script uses pre-existing build products from Jenkins
29 that are built on Debian unstable. This makes the build product run on none
30 but the latest distributions. A much better choice would be to build e.g.,
31 on Debian oldstable, CentOS 6, or Ubuntu Trusty or earlier.
32 Examples for building bleeding-edge Qt4 and Qt5 applications on such mature
33 build systems can be found at
34 https://github.com/probonopd/AppImages/blob/master/recipes
35
36 The script has been tested on Ubuntu 16.04 but is assumed
37 to also run on Debian unstable with no or minor changes. However, it is
38 strongly suggested to build and package the AppImage on a significantly
39 older distribution as mentioned above for any productive use.
40
41
42 Building
43 --------
44
45  $ ./sigrok-native-appimage
46
47 Per default it will put the AppImage in:
48
49  ./out/*.AppImage
50
51 Please edit the script if you want to change any settings.