Add snapcraft.yaml to osmclient
[osm/osmclient.git] / snap / local / README.md
1 ##
2 # Copyright 2020 ETSI
3 #
4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
5 # not use this file except in compliance with the License. You may obtain
6 # a copy of the License at
7 #
8 #         http://www.apache.org/licenses/LICENSE-2.0
9 #
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 # License for the specific language governing permissions and limitations
14 # under the License.
15 ##
16
17 # Snap for OSM client
18
19 The snapcraft.yaml located in this folder, allows to build a snap of the OSM client
20
21
22 ## Build
23
24 ```bash
25 # Build the snap
26 $ snapcraft --use-lxd
27 ...
28 Staging client
29 Priming client
30 Determining the version from the project repo (version: git).
31 The version has been set to 'v7.1.0+git4.a4af86f-dirty'
32 Snapping 'osmclient' \
33 Snapped 'osmclient_v7.1.0+git4.a4af86f-dirty_amd64.snap'
34 ```
35
36 ## Install
37
38 ```bash
39 $ sudo snap install --devmode osmclient_v7.1.0+git4.a4af86f-dirty_amd64.snap
40 osmclient v7.1.0+git4.a4af86f-dirty installed
41 $ sudo snap alias osmclient.osm osm
42 ```