sigrok-cross-mingw: Also build PV manual

[sigrok-util.git] / cross-compile / appimage / README

diff --git a/cross-compile/appimage/README b/cross-compile/appimage/README
index 9e3d714fc7f2c84903d323b9c16b5ccc21dee820..f4c7fa1ab551694960d6099d28b80661e1b57366 100644 (file)
--- a/cross-compile/appimage/README
+++ b/cross-compile/appimage/README
@@ -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,9 +12,6 @@ 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
 ------
@@ -29,6 +26,24 @@ Requirements
 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
+
+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 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.
@@ -37,9 +52,15 @@ can run on as many different systems as possible.
 Building
 --------
 
+For PulseView:
+
  $ ./sigrok-native-appimage
 
-Per default it will put the AppImage in:
+For sigrok-cli:
+
+ $ ./sigrok-native-appimage sigrok-cli
+
+Per default the script will put the AppImages in:
 
  ./out/*.AppImage