xref: /aosp_15_r20/external/lz4/contrib/snap/README.md (revision 27162e4e17433d5aa7cb38e7b6a433a09405fc7f)
1*27162e4eSAndroid Build Coastguard WorkerSnap Packaging
2*27162e4eSAndroid Build Coastguard Worker--------------
3*27162e4eSAndroid Build Coastguard Worker
4*27162e4eSAndroid Build Coastguard WorkerThis directory contains the config required to generate a snap package
5*27162e4eSAndroid Build Coastguard Workerof lz4. Snaps are universal Linux packages that allow you to easily
6*27162e4eSAndroid Build Coastguard Workerbuild your application from any source and ship it to any Linux
7*27162e4eSAndroid Build Coastguard Workerdistribution by publishing it to https://snapcraft.io/. A key attribute
8*27162e4eSAndroid Build Coastguard Workerof a snap package is that it is (ideally) confined such that it
9*27162e4eSAndroid Build Coastguard Workerexecutes within a controlled environment with all its dependencies
10*27162e4eSAndroid Build Coastguard Workerbundled with it and does not share dependencies with of from any other
11*27162e4eSAndroid Build Coastguard Workerpackage on the system (with a couple of minor exceptions).
12*27162e4eSAndroid Build Coastguard Worker
13*27162e4eSAndroid Build Coastguard WorkerThe basic anatomy and workflow is:
14*27162e4eSAndroid Build Coastguard Worker
15*27162e4eSAndroid Build Coastguard Worker  * ensure snap.snapcraft.yaml is up-to-date e.g. with version info
16*27162e4eSAndroid Build Coastguard Worker
17*27162e4eSAndroid Build Coastguard Worker  * build the snap by installing the snapcraft package and running it
18*27162e4eSAndroid Build Coastguard Worker
19*27162e4eSAndroid Build Coastguard Worker  * push snap/* changes to the repo (excluding any crud generated by a build of course)
20*27162e4eSAndroid Build Coastguard Worker
21*27162e4eSAndroid Build Coastguard Worker  * register yourself as owner of lz4 name in snapstore
22*27162e4eSAndroid Build Coastguard Worker
23*27162e4eSAndroid Build Coastguard Worker  * publish new snap to the snap store
24*27162e4eSAndroid Build Coastguard Worker
25*27162e4eSAndroid Build Coastguard Worker  * install snap by doing 'snap install lz4' on any Linux distro
26*27162e4eSAndroid Build Coastguard Worker
27*27162e4eSAndroid Build Coastguard Worker  * all installed copies of lz4 will be automatically updated to your new version
28*27162e4eSAndroid Build Coastguard Worker
29*27162e4eSAndroid Build Coastguard WorkerFor more information on Snaps see https://docs.snapcraft.io and https://forum.snapcraft.io/
30