snapcast icon indicating copy to clipboard operation
snapcast copied to clipboard

Improve the Readme

Open ahormann opened this issue 3 years ago • 1 comments

This is not really a feature-request, is just want to tell you why setting this awesome tool up took me longer than necessary. So maybe i can help other people that are as inexperienced as me... I read "After installation, Snapserver and Snapclient are started with ..." as i would have to start it manually as i am used to it, so i did this and had double playback-speed and was confused for a while. Second problem: As i am not used to services i missed a note how to restart the server (systemctl restart snapserver) to reload the configurations.

So personally i would have liked something like this:

Running

The server and client are started as service automatically after installation and controlled as follows: stop: systemctl stop snapserver start (only required after stop): systemctl start snapserver restart: systemctl restart snapserver After stopping the service one can also run "snapserver" to get the logs printed.

That said i would definitely would not have documented it better myself, great job!!!

ahormann avatar Jan 13 '21 18:01 ahormann

Allthou it would be great to be able to write simple and understandable docs for each system, They are dependent on the underlying OS and installation form. It would be hard to navigate the docs and find the right one. Instead the docs are for the actual software irregardless of how you have installed it or on which OS

In other words, not all systems have systemd and thus systemctl. The docs are meant to be usable cross system regardless of self-compiled or installed via package or on windows/macOS/linux.

also note, After stopping the service one can also run "snapserver" to get the logs printed. is not true, in your case you would write somthing like journalctl -u snapserver.service to view logs. starting snapserver manually displays output but it is not the same thing as logs (read - happened earlier in time)

TekniskSupport avatar Jan 15 '21 07:01 TekniskSupport