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