Add a quick start guide

.drone-manifest.yml

@@ -1,4 +1,4 @@
-image: registry.nemunai.re/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
+image: nemunaire/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
 {{#if build.tags}}
 tags:
 {{#each build.tags}}
@@ -6,16 +6,16 @@ tags:
 {{/each}}
 {{/if}}
 manifests:
-  - image: registry.nemunai.re/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-amd64
+  - image: nemunaire/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-amd64
     platform:
       architecture: amd64
       os: linux
-  - image: registry.nemunai.re/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm64
+  - image: nemunaire/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm64
     platform:
       architecture: arm64
       os: linux
       variant: v8
-  - image: registry.nemunai.re/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm
+  - image: nemunaire/hathoris:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm
     platform:
       architecture: arm
       os: linux

.drone.yml

@@ -71,11 +71,22 @@ steps:
     event:
         - tag
 
+- name: github release
+  image: plugins/github-release:linux-arm
+  settings:
+    api_key:
+      from_secret: github_api_token
+    files:
+      - deploy/hathoris-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}hf
+      - deploy/hathoris-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}v7
+  when:
+    event:
+        - tag
+
 - name: docker
   image: plugins/docker:linux-arm
   settings:
-    registry: registry.nemunai.re
+    repo: nemunaire/hathoris
-    repo: registry.nemunai.re/hathoris
     auto_tag: true
     auto_tag_suffix: ${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
     dockerfile: Dockerfile-norebuild
@@ -130,11 +141,21 @@ steps:
     files:
       - deploy/hathoris-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
 
+- name: github release
+  image: plugins/github-release
+  settings:
+    api_key:
+      from_secret: github_api_token
+    files:
+      - deploy/hathoris-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
+  when:
+    event:
+        - tag
+
 - name: docker
   image: plugins/docker
   settings:
-    registry: registry.nemunai.re
+    repo: nemunaire/hathoris
-    repo: registry.nemunai.re/hathoris
     auto_tag: true
     auto_tag_suffix: ${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
     dockerfile: Dockerfile-norebuild
@@ -187,11 +208,21 @@ steps:
     files:
       - deploy/hathoris-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
 
+- name: github release
+  image: plugins/github-release
+  settings:
+    api_key:
+      from_secret: github_api_token
+    files:
+      - deploy/hathoris-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
+  when:
+    event:
+        - tag
+
 - name: docker
   image: plugins/docker
   settings:
-    registry: registry.nemunai.re
+    repo: nemunaire/hathoris
-    repo: registry.nemunai.re/hathoris
     auto_tag: true
     auto_tag_suffix: ${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
     dockerfile: Dockerfile-norebuild

README.md

@@ -47,8 +47,27 @@ Hathoris is compatible with any Linux distribution that has PulseAudio. It also
 
 ### Quick Installation Guide
 
-TODO: Add a quick installation guide.
+1. Install dependancies.
 
+   On Debian/Ubuntu/Raspbian/armbian/...: `sudo apt install alsa-utils pulseaudio-utils mpv yt-dlp`
+   On Alpine: `sudo apk add alsa-utils pulseaudio-utils mpv yt-dlp`
+   On ArchLinux/Manjaro: `sudo pacman -S alsa-utils pulseaudio mpv yt-dlp`
+
+2. Download the latest release binary for your architecture; choose between ARMv6 (Raspberry Pi Zero), ARMv7 (Voltastreams, Raspberry Pi 2+), ARM64 (Raspberry Pi Zero 2 and 3+ **with 64 bits OS**): https://git.nemunai.re/nemunaire/hathoris/releases/latest
+
+3. Give execution permissions: `chmod +x hathoris-linux-armv7`
+
+4. (optional) [Prepare a configuration for optional virtual inputs](#audio-sources) (like radios, streaming sources)
+
+   The file is called `settings.json`, it is expected to be in the directory where you execute `hathoris`. It can be overwrited by adding a command line argument like `-settings-file /etc/hathoris/settings.json`.
+
+5. Launch the binary: `./hathoris -bind :8081`
+
+6. The interface will be available on the port 8081 from anywhere on your local network.
+
+   From your local machine, it'll be on <http://localhost:8081/>
+
+Enjoy!
 
 ### Build the Project