nemunaire/hathoris
1
0
Fork 0
Code Issues Pull requests Projects Releases 13 Packages Wiki Activity

Add a quick start guide
Some checks reported errors
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build was killed
Details

Browse source
This commit is contained in:
nemunaire 2025-04-26 11:19:36 +02:00
parent 2aff54281e
commit 10fb167d65
1 changed files with 20 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -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