1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/LINUX_README	Wed Jan 14 06:51:16 2015 +0200
     1.3 @@ -0,0 +1,57 @@
     1.4 +WHAT SETUP IS REQUIRED?
     1.5 +
     1.6 +  * Appropriate permissions for Oculus hidraw devices. See
     1.7 +    LibOVR/90-oculus.rules and ConfigureDebian.sh.
     1.8 +  * Use a multihead setup with one X screen spanning both displays (such as
     1.9 +    NVidia TwinView) or place the rift on an independent X screen.
    1.10 +  * Ensure oculusd is running when using the rift.
    1.11 +
    1.12 +BUILD INSTRUCTIONS
    1.13 +
    1.14 +  After installing the appropriate packages issue 'make' in the root of
    1.15 +  the SDK directory. This will build a release version of Oculus World Demo
    1.16 +  (OWD). To generate debug symbols use 'make DEBUG=1'.
    1.17 +
    1.18 +HOW DO I RUN OCULUS WORLD DEMO (OWD)?
    1.19 +
    1.20 +  Either run the binary directly from the output directory, or use 'make run'.
    1.21 +
    1.22 +SHOULD I ROTATE MY DEVICE'S SCREEN?
    1.23 +
    1.24 +  Manual screen rotation is not recommended. If your window is fullscreen on a
    1.25 +  rift device, set the ovrDistortionCap_LinuxDevFullscreen distortion cap to
    1.26 +  have the SDK automatically rotate the distortion mesh on appropriate devices.
    1.27 +  Be aware you will have to account for window size. You can use
    1.28 +  OVR::SDKWindow::findDevScreenForHMD (Displays/OVR_Linux_SDKWindow.h) to
    1.29 +  return the screen offset and dimensions necessary to size your Linux window.
    1.30 +  See Samples/CommonSrc/Platform/Linux_Platform.cpp for an example.
    1.31 +
    1.32 +TWINVIEW
    1.33 +
    1.34 +  You must sync to the Rift's display device for a smooth experience when using
    1.35 +  TwinView. To consistently sync to the rift with TwinView setups, set the
    1.36 +  __GL_SYNC_DISPLAY_DEVICE environment variable to the appropriate display
    1.37 +  device before X starts. For example in your /etc/profile you could place the
    1.38 +  following:
    1.39 +
    1.40 +    export __GL_SYNC_DISPLAY_DEVICE="DFP-1"
    1.41 +
    1.42 +  if your rift corresponds to DFP-1.
    1.43 +
    1.44 +STARTING THE TRACKING SERVICE AUTOMATICALLY
    1.45 +
    1.46 +  Start the tracking service when a user is logged in using Xsession files.
    1.47 +
    1.48 +UBUNTU USERS
    1.49 +
    1.50 +  There was a ubuntu-specific kernel bug which affected HID devices in 14.04.
    1.51 +  If you are receiving feature report failures try upgrading your distro
    1.52 +  (dist-upgrade).
    1.53 +
    1.54 +KNOWN ISSUES
    1.55 +
    1.56 +  * OWD vsync initially disabled on Radeon proprietary.
    1.57 +  * Frame loss on NVidia TwinView setups. Use an independent X screen for an
    1.58 +    optimal experience.
    1.59 +  * Mesa DK2 latency tester does not function properly in OWD.
    1.60 +