cross-compile/appimage/README

   1 -------------------------------------------------------------------------------
   2 README
   3 -------------------------------------------------------------------------------
   4
   5 This is a small script for bundling PulseView/sigrok-cli 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
  16 Status
  17 ------
  18
  19 Working AppImages (stable releases and nightly builds) are provided here:
  20 https://sigrok.org/wiki/Downloads
  21
  22
  23 Requirements
  24 ------------
  25
  26 The script assumes you have built all of the sigrok subprojects and
  27 installed them into $HOME/sr (e.g. via the sigrok-cross-linux script).
  28
  29 It also assumes you have built AppImageKit in $HOME. First, install all
  30 build requirements of AppImageKit (see AppImageKit docs or its
  31 install-build-deps.sh file). Then:
  32
  33  $ cd $HOME
  34  $ git clone https://github.com/AppImage/AppImageKit
  35  $ cd AppImageKit
  36
  37 Apply chdir.patch (required to fix sigrok bug #1300), then build:
  38
  39  $ patch -p1 < chdir.patch
  40  $ ./build.sh
  41
  42 Temporary workaround for an AppImageKit issue:
  43
  44  $ mkdir -p build/lib/appimagekit
  45  $ cp build/out/mksquashfs build/lib/appimagekit
  46
  47 The AppImages are tested to build fine on Ubuntu 16.04 (32bit and 64bit).
  48 These older distros are used for the build so that the generated AppImages
  49 can run on as many different systems as possible.
  50
  51
  52 Building
  53 --------
  54
  55 For PulseView:
  56
  57  $ ./sigrok-native-appimage
  58
  59 For sigrok-cli:
  60
  61  $ ./sigrok-native-appimage sigrok-cli
  62
  63 Per default the script will put the AppImages in:
  64
  65  ./out/*.AppImage
  66
  67 Please edit the script if you want to change any settings.