Add a quick start guide
This commit is contained in:
parent
2aff54281e
commit
10fb167d65
1 changed files with 20 additions and 1 deletions
21
README.md
21
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
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue