Commit 80a7a8e6 authored by Jonas Jelten's avatar Jonas Jelten

add usage information to readme

parent 09ccd6bd
......@@ -21,13 +21,48 @@ Dependencies
Invocation
----------
Try invoking with `--help` to see usage and configuration information.
Try invoking with `python3 -m videoscreen --help` to see usage and configuration information.
```
python3 -m videoscreen -- --fs
python3 -m videoscreen -- --fs --quiet
```
Options after the `--` are passed to mpv.
All options after the `--` are passed to mpv.
systemd user service
--------------------
* Copy or symlink the `etc/videoscreen.service` to `~/.config/systemd/user/`
* Activate and launch it `systemctl --user enable --now videoscreen.service`
Usage
-----
The following commands can be issued to the host:
Command | What
--------|-----
`help` | show usage help
`$video_url` | play video url
`vol [+-=]$number` | change the system volume
`exit` | terminate connection
### Examples
Invoke the commands by sending to port `60601` of the host:
``` shell
# play a video
echo "$video_url" | nc $host $port
# change volume
echo "vol +13" | nc $host $port
echo "vol 33" | nc $host $port
echo "vol -37" | nc $host $port
```
License
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment