Browse Source

Updated readme

Joachim M. Giæver 4 years ago
parent
commit
79e3958fa1
2 changed files with 18 additions and 15 deletions
  1. 16 14
      README.md
  2. 2 1
      snap/snapcraft.yaml

+ 16 - 14
README.md

@@ -2,18 +2,20 @@
 
 
 Snap (Snapcraft.yaml) recipe for the Open source home automation software that puts local control and privacy first.
 Snap (Snapcraft.yaml) recipe for the Open source home automation software that puts local control and privacy first.
 
 
-Current Home Assistant version: 0.90.1
+Our tagging is reflecting the Home Assistant version numbers.
+
+[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/home-assistant-snap)
 
 
 # Build
 # Build
 Simply
 Simply
 
 
-1. ##### Clone repo over HTTPS
+1. **Clone repo over HTTPS**
 
 
 ```
 ```
 git clone https://git.giaever.org/joachimmg/home-assistant-snap.git
 git clone https://git.giaever.org/joachimmg/home-assistant-snap.git
 ```
 ```
 
 
-2. ##### Change directory into the cloned repository
+2. **Change directory into the cloned repository**
 
 
 ```
 ```
 $ cd ~/home-assistant-snap/
 $ cd ~/home-assistant-snap/
@@ -21,43 +23,43 @@ $ cd ~/home-assistant-snap/
 
 
 and checkout the latest tag (e.g `$ git checkout 0.112.3`) as the master branch might not be functioning.
 and checkout the latest tag (e.g `$ git checkout 0.112.3`) as the master branch might not be functioning.
 
 
-3. ##### Build & install
+3. **Build & install**
 3.1 Make sure you have snapcraft installed: 
 3.1 Make sure you have snapcraft installed: 
 
 
 ```
 ```
 sudo snap install snapcraft --classic && hash -r
 sudo snap install snapcraft --classic && hash -r
 ```
 ```
 
 
-3.2 Build with 
+3.2 **Build with**
 
 
 ```
 ```
 $ snapcraft
 $ snapcraft
 ```
 ```
 
 
-3.3 Install with (change «packagename» to filename of the produced snap).
+3.3 **Install with** (change «packagename» to filename of the produced snap).
 
 
 ```
 ```
 $ ls -al | grep .snap
 $ ls -al | grep .snap
 $ snap install --devmode --dangerous <packagename>.snap
 $ snap install --devmode --dangerous <packagename>.snap
 ``` 
 ``` 
 
 
-4. #### Notes on building on a Raspberry Pi
+4. **Notes on building on a Raspberry Pi**
 
 
-Snapcraft will try to install multipass for you, but on *Raspberry Pi* it will fail. You will have to use an LXD container, before any of the previous steps.
+Snapcraft will try to install multipass for you, but on *Raspberry Pi* it will fail. You will have to use an LXD container, **before** any of the previous steps.
 
 
-4.1 Install LXD on the Pi:
+4.1 **Install LXD on the Pi**
 
 
 ```
 ```
 $ snap install lxd
 $ snap install lxd
 ```
 ```
 
 
-4.2 Create a container
+4.2 **Create a container**
 
 
 ```
 ```
 $ sudo lxd init
 $ sudo lxd init
 ```
 ```
 
 
-4.3 Make sure your user is a member of lxd-group
+4.3 **Make sure your user is a member of lxd-group**
 
 
 ```
 ```
 sudo adduser $USER lxd
 sudo adduser $USER lxd
@@ -65,18 +67,18 @@ sudo adduser $USER lxd
 
 
 _(it might tell that you already are...)_
 _(it might tell that you already are...)_
 
 
-4.4 Launche a Ubuntu 20.04 container instance
+4.4 **Launch an Ubuntu 20.04 container instance**
 ```
 ```
 lxc launch ubuntu:20.04 home-assistant-container
 lxc launch ubuntu:20.04 home-assistant-container
 ```
 ```
 
 
-4.5 Go into the shell of the container
+4.5 **Go into the shell of the container**
 
 
 ```
 ```
 lxc exec -- home-assistant-container /bin/bash
 lxc exec -- home-assistant-container /bin/bash
 ```
 ```
 
 
-4.6 Continue with *step 1*, but replace *step 3.2* with the following:
+4.6 **Continue with *step 1*, but replace *step 3.2* with the following:**
 
 
 ```
 ```
 SNAPCRAFT_BUILD_ENVIRONMENT=host snapcraft
 SNAPCRAFT_BUILD_ENVIRONMENT=host snapcraft

+ 2 - 1
snap/snapcraft.yaml

@@ -1,4 +1,4 @@
-name: home-assistant
+name: home-assistant-snap
 version: '0.112.3'
 version: '0.112.3'
 summary: Open source home automation that puts local control and privacy first
 summary: Open source home automation that puts local control and privacy first
 description: |
 description: |
@@ -6,6 +6,7 @@ description: |
     It is able to track and control all devices at home and offer a 
     It is able to track and control all devices at home and offer a 
     platform for automating control.
     platform for automating control.
 base: core20
 base: core20
+grade: stable
 confinement: strict
 confinement: strict
 apps:
 apps:
   hass:
   hass: