sigrok-native-appimage: Support building a sigrok-cli AppImage.
[sigrok-util.git] / cross-compile / appimage / README
index fd2a8ba1f527b3c36fc0135e8a70c9b6cbff705e..f3c83d0c1b055e69199bd1b09de4c4ca9e83b976 100644 (file)
@@ -2,7 +2,7 @@
 README
 -------------------------------------------------------------------------------
 
-This is a small script for bundling PulseView and its dependencies
+This is a small script for bundling PulseView/sigrok-cli and its dependencies
 for Linux systems as an AppImage.
 
 AppImage is a bundle format for Linux applications that allows the user to 
@@ -19,32 +19,33 @@ https://github.com/probonopd/AppImages
 Status
 ------
 
-Work in progress.
+Working, nightly AppImages are provided here:
+https://sigrok.org/jenkins/job/sigrok-native-appimage/
 
 
 Requirements
 ------------
 
-Currently the bundle.sh script uses pre-existing build products from Jenkins
-that are built on Debian unstable. This makes the build product run on none
-but the latest distributions. A much better choice would be to build e.g.,
-on Debian oldstable, CentOS 6, or Ubuntu Trusty or earlier.
-Examples for building bleeding-edge Qt4 and Qt5 applications on such mature
-build systems can be found at
-https://github.com/probonopd/AppImages/blob/master/recipes
+The script assumes you have built all of the sigrok subprojects and
+installed them into $HOME/sr (e.g. via the sigrok-cross-linux script).
 
-The bundle.sh script has been tested on Ubuntu 16.04 but is assumed
-to also run on Debian unstable with no or minor changes. However, it is
-strongly suggested to build and package the AppImage on a significantly
-older distribution as mentioned above for any productive use.
+The AppImages are tested to build fine on Ubuntu 14.04 (32bit and 64bit).
+These older distros are used for the build so that the generated AppImages
+can run on as many different systems as possible.
 
 
 Building
 --------
 
- $ ./bundle.sh
+For PulseView:
 
-Per default it will put the AppImage in:
+ $ ./sigrok-native-appimage
+
+For sigrok-cli:
+
+ $ ./sigrok-native-appimage sigrok-cli
+
+Per default the script will put the AppImages in:
 
  ./out/*.AppImage