sigrok-native-appimage: Bump to use Ubuntu 16.04 as base OS.
[sigrok-util.git] / cross-compile / appimage / README
index fd2a8ba1f527b3c36fc0135e8a70c9b6cbff705e..d8a353197edb74ea2ed28b9c8f084058b5d6b6e5 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 
@@ -12,39 +12,55 @@ No need to install. No system libraries or system preferences are altered.
 For more information on AppImage, please see
 http://appimage.org/
 
-For example AppImages, please see
-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).
+
+It also assumes you have built AppImageKit in $HOME. First, install all
+build requirements of AppImageKit (see AppImageKit docs or its
+install-build-deps.sh file). Then:
+
+ $ cd $HOME
+ $ git clone https://github.com/AppImage/AppImageKit
+ $ cd AppImageKit
+
+Apply chdir.patch (required to fix sigrok bug #1300), then build:
+
+ $ patch -p1 < chdir.patch
+ $ ./build.sh
 
-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.
+Temporary workaround for an AppImageKit issue:
+
+ $ mkdir -p build/lib/appimagekit
+ $ cp build/out/mksquashfs build/lib/appimagekit
+
+The AppImages are tested to build fine on Ubuntu 16.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:
+
+ $ ./sigrok-native-appimage
+
+For sigrok-cli:
+
+ $ ./sigrok-native-appimage sigrok-cli
 
-Per default it will put the AppImage in:
+Per default the script will put the AppImages in:
 
  ./out/*.AppImage