From 9113bf0a54f598e36615f26417276aa46e59754f Mon Sep 17 00:00:00 2001 From: Christoph Stahl Date: Tue, 19 Dec 2023 13:47:14 +0100 Subject: [PATCH] Installation was wrong :/ --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5b88e89..72234a7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Syng -Syng is a all-in-one karaoke software, consisting of a *backend server*, a *web frontend* and a *playback client*. -Karaoke performers can search a library using the web fronend, and add songs to the queue. +Syng is an all-in-one karaoke software, consisting of a *backend server*, a *web frontend* and a *playback client*. +Karaoke performers can search a library using the web frontend, and add songs to the queue. The playback client retrieves songs from the backend server and plays them in order. -Currently songs can be accessed using the following sources: +Currently, songs can be accessed using the following sources: - - **Youtube.** The backend server queries YouTube for the song and forwards the URL to the playback client. The playback client then downloads the video from YouTube for playback. + - **YouTube.** The backend server queries YouTube for the song and forwards the URL to the playback client. The playback client then downloads the video from YouTube for playback. - **S3.** The backend server holds a list of all file paths accessible through the s3 storage, and forwards the chosen path to the playback client. The playback client then downloads the needed files from the s3 for playback. - **Files.** Same as S3, but all files reside locally on the playback client. @@ -16,12 +16,12 @@ The playback client uses `mpv` for playback and can therefore play a variety of ## Server - pip install git+https://github.com/christofsteel/syng -E server + pip install "syng[server] @ git+https://github.com/christofsteel/syng.git" This installs the server part (`syng-server`), if you want to self-host a syng server. There is a publicly available syng instance at https://syng.rocks. ## Client - pip install git+https://github.com/christofsteel/syng -E client + pip install "syng[client] @ git+https://github.com/christofsteel/syng.git" This installs both the playback client (`syng-client`) and a configuration GUI (`syng-gui`).