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

-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------

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 
download an application, make it executable, and run.
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
------

Working, nightly AppImages are provided here:
https://sigrok.org/jenkins/job/sigrok-native-appimage/


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).

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
--------

For PulseView:

 $ ./sigrok-native-appimage

For sigrok-cli:

 $ ./sigrok-native-appimage sigrok-cli

Per default the script will put the AppImages in:

 ./out/*.AppImage

Please edit the script if you want to change any settings.
Commit	Line	Data
	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	For example AppImages, please see
	16	https://github.com/probonopd/AppImages
	17
	18
	19	Status
	20	------
	21
	22	Working, nightly AppImages are provided here:
	23	https://sigrok.org/jenkins/job/sigrok-native-appimage/
	24
	25
	26	Requirements
	27	------------
	28
	29	The script assumes you have built all of the sigrok subprojects and
	30	installed them into $HOME/sr (e.g. via the sigrok-cross-linux script).
	31
	32	The AppImages are tested to build fine on Ubuntu 14.04 (32bit and 64bit).
	33	These older distros are used for the build so that the generated AppImages
	34	can run on as many different systems as possible.
	35
	36
	37	Building
	38	--------
	39
	40	For PulseView:
	41
	42	$ ./sigrok-native-appimage
	43
	44	For sigrok-cli:
	45
	46	$ ./sigrok-native-appimage sigrok-cli
	47
	48	Per default the script will put the AppImages in:
	49
	50	./out/*.AppImage
	51
	52	Please edit the script if you want to change any settings.