libgoatvr

diff doc/index.rst @ 25:bb85be761b50

started the documentation
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 08 Mar 2015 05:30:02 +0200
parents
children e819f63535b3
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/index.rst	Sun Mar 08 05:30:02 2015 +0200
     1.3 @@ -0,0 +1,22 @@
     1.4 +libgoatvr
     1.5 +=========
     1.6 +
     1.7 +**This documentation is incomplete**
     1.8 +
     1.9 +Overview
    1.10 +--------
    1.11 +
    1.12 +Libgoatvr is a simplified abstraction library for dealing with VR headsets. It
    1.13 +is designed to expose a single common API to access VR HMDs through any of the
    1.14 +supported backend modules, such as the Oculus SDK or OpenHMD, even allowing the
    1.15 +application to switch between them at runtime.
    1.16 +
    1.17 +This documentation describes how to use libgoatvr in your programs, and is
    1.18 +split into the following sections:
    1.19 +
    1.20 + 1. Initialization_
    1.21 + 2. Head tracking
    1.22 + 3. Rendering
    1.23 + 4. options and properties
    1.24 +
    1.25 +.. _Initialization: 1-init.html