# HG changeset patch
# User John Tsiombikas <nuclear@member.fsf.org>
# Date 1425785402 -7200
# Node ID bb85be761b503ac316ef1bb883481be9807e698d
# Parent  d659cbedde1de585eedd414ed34fec6ea58e327f
started the documentation

diff -r d659cbedde1d -r bb85be761b50 README
--- a/README	Wed Jan 14 08:03:27 2015 +0200
+++ b/README	Sun Mar 08 05:30:02 2015 +0200
@@ -6,10 +6,10 @@
 Libgoatvr is a simplified abstraction library for dealing with VR headsets. It
 is designed to expose a single common API to access VR HMDs through any of the
 supported backend modules, such as the Oculus SDK or OpenHMD, even allowing the
-application to switch between them seamlessly at runtime.
+application to switch between them at runtime.
 
 Currently implemented VR modules:
- - Oculus SDK 0.4.1
+ - Oculus SDK 0.4.4
  - OpenHMD (not done)
  - null
 
diff -r d659cbedde1d -r bb85be761b50 doc/1-init.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/1-init.rst	Sun Mar 08 05:30:02 2015 +0200
@@ -0,0 +1,57 @@
+Initialization
+--------------
+
+Before calling any other function you need to initialize the VR library by
+calling ``vr_init``. Similarly, ``vr_shutdown`` frees up all resources held by
+the library.
+
+Libgoatvr has a number of backend modules for interfacing with VR headsets, and
+there might be multiple modules compiled with your version of libgoatvr. If you
+don't want to rely on the built-in defaults, you might want to enumerate and
+select which module to use.
+
+The following example initializes the library, and prints the list of available
+VR modules:
+
+.. code:: c
+
+ #include <stdio.h>
+ #include <goatvr.h>
+ 
+ int main(void)
+ {
+ 	int i, nmod;
+ 
+ 	if(vr_init() == -1) {
+ 		fprintf(stderr, "failed to initialize goatvr\n");
+ 		return 1;
+ 	}
+ 
+ 	nmod = vr_module_count();
+ 	printf("There are %d modules:\n", nmod);
+ 	for(i=0; i<nmod; i++) {
+ 		printf(" %2d - %s\n", i, vr_module_name(i));
+ 	}
+ 	vr_shutdown();
+ 	return 0;
+ }
+ 
+Running this on my computer, with the Oculus Rift DK2 connected, and oculusd
+running, produces this output::
+
+ initialized LibOVR 0.4.4
+ 1 Oculus HMD(s) found
+  [0]: Oculus VR - Oculus Rift DK2
+ using vr module: libovr
+ There are 2 modules:
+   0 - libovr
+   1 - null
+
+The first four lines come from the initialization of the ``libovr`` module which
+is selected by default if it's available. If however I turn off the DK2 or stop
+the daemon, then I'm getting just the ``null`` module in this list.
+
+If you'd like to override the default selected module, and use the ``null``
+module instead of ``libovr``, which is useful during development to avoid having
+to put the HMD on and off all the time, you can call ``vr_use_module(1)``, or
+``vr_use_module_named("null")``.
diff -r d659cbedde1d -r bb85be761b50 doc/Makefile
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/Makefile	Sun Mar 08 05:30:02 2015 +0200
@@ -0,0 +1,12 @@
+rstfiles = $(wildcard *.rst)
+htmlfiles = $(rstfiles:.rst=.html)
+
+.PHONY: html
+html: $(htmlfiles)
+
+%.html: %.rst
+	rst2html $(RSTFLAGS) $< >$@
+
+.PHONY: clean
+clean:
+	rm -f $(htmlfiles)
diff -r d659cbedde1d -r bb85be761b50 doc/index.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst	Sun Mar 08 05:30:02 2015 +0200
@@ -0,0 +1,22 @@
+libgoatvr
+=========
+
+**This documentation is incomplete**
+
+Overview
+--------
+
+Libgoatvr is a simplified abstraction library for dealing with VR headsets. It
+is designed to expose a single common API to access VR HMDs through any of the
+supported backend modules, such as the Oculus SDK or OpenHMD, even allowing the
+application to switch between them at runtime.
+
+This documentation describes how to use libgoatvr in your programs, and is
+split into the following sections:
+
+ 1. Initialization_
+ 2. Head tracking
+ 3. Rendering
+ 4. options and properties
+
+.. _Initialization: 1-init.html