diff --git a/README.org b/README.org index 6adcaeb..f26f5c7 100644 --- a/README.org +++ b/README.org @@ -3,7 +3,7 @@ *strm* is a small Bash script that lets you stream media files over SSH in a convenient way. No need for mounting and navigating through complex directory structures anymore. - Just provide a query and the matching media files are played locally via [[https://mpv.io/][mpv]]. + Just provide a query and the matching media files are played locally (or remote) via [[https://mpv.io/][mpv]]. Here is an example.. let's assume you have the shortfilm [[https://www.dailydweebs.com/][The Daily Dweebs]] stored on a remote machine in the following directory structure: @@ -58,14 +58,22 @@ mpv has a nice feature which lets you resume playback. This is handy if you want to e.g. continue watching you favourite series at a later point in time. Check the *usage* below to see how this works. + +** Dependencies + + The dependencies vary, based on the purpose of a machine: + + - The machine shall serve as data storage :: It must be available via SSH. + - The machine shall serve as player :: [[https://mpv.io/][mpv]] and an SSH client must be installed. + - The machine shall serve as player and will be remote controlled :: mpv, *strm*, [[https://github.com/tmux/][tmux]] and an SSH client must be installed and it must be available via SSH. + - The machine shall serve only as controller :: An SSH client must be installed. + + A machine can be used for multiple purposes, make sure all required dependencies are fulfilled. ** Installation - Make sure, mpv is installed and that you have access to a machine via SSH. - If you plan to execute *strm* on a remote machine with the =--remote= flag, install [[https://github.com/tmux/][tmux]] in addition to mpv on the target. - *strm* is just a script, you can execute it directly. - Or grab it and place it in your =$PATH=. + Or grab it, make it executable and place it in your =$PATH=. This project is also a [[https://nixos.wiki/wiki/Flakes][Nix flake]]. You can execute it with the following command if you have a recent version of [[https://nixos.org/][Nix]] installed and flakes are enabled: @@ -116,12 +124,9 @@ *** The =--remote= flag - The =--remote= flag executes *strm* on another machine in a tmux session and passes all other arguments to it. - For this, *strm* needs to be installed and configured on the remote machine. + The =--remote= flag executes *strm* on another machine in a tmux session and passes all other given arguments to it. Launching it in a tmux session allows to detach from the session with =C-b d=. - - If a session is already running on the target machine, the session gets attached. - Further commands are ignored (it is even sufficient to call =strm -r =). + If a session is already running on the target machine, the session gets attached and further commands are ignored (it is even sufficient to call =strm -r = to reattach). If you pass the =--media-directories= flag, *strm* doesn't need to be configured but make sure your arguments are correct from the point of view of the remote machine. The same holds true if you pass the =--config= flag.