aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8e4c1f1..066c1de 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,6 @@
-A virtual reality window manager 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 ready to be used yet.
-
+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.\
+# 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.