aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2020-04-29 20:51:51 +0200
committerdec05eba <dec05eba@protonmail.com>2020-04-29 20:51:51 +0200
commit96dc9bfa19e08bb39eb69d68943815f6f564406d (patch)
tree48e47cc2128fd3960a397fbf19983069d0d0ef1a /README.md
parent9f322aff8bc16195a7950cddb0441e8f064c4eff (diff)
Update readme with installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 066c1de..49a95cc 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,11 @@
-A virtual reality video player for Linux running X11, based on Valve's openvr `hellovr_opengl` sample code: https://github.com/ValveSoftware/openvr/tree/master/samples\
-Still early in development, not very user friendly.\
-Currently only works with stereo video.\
+A virtual reality video player for Linux running X11, based on Valve's openvr `hellovr_opengl` sample code: https://github.com/ValveSoftware/openvr/tree/master/samples
+Still early in development, not very user friendly.
+
+Currently only works with stereo video.
+
+# Installation
+vr video player can be built using [sibs](https://github.com/DEC05EBA/sibs) or if you are running Arch Linux, then you can find it on aur under the name vr-video-player-git (`yay -S vr-video-player-git`).
+
# How to use
Start a video in your video player of choice (tested with mpv) and then get the x11 window id (this can be done with xwininfo) and then fullscreen the video (for best quality).
Then launch `vr_video_player` with the x11 window id.