From b993ce9b738168d8282ff04a104a719ea224b711 Mon Sep 17 00:00:00 2001 From: bjorn Date: Thu, 8 Dec 2016 18:35:12 -0800 Subject: [PATCH] Update README; --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 49cf1f43..644e2613 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ LÖVR === -LÖVR lets you make VR games with Lua! See . +LÖVR is a simple framework for creating virtual reality experiences with Lua. For more information, +visit the [project page](http://bjornbyt.es/lovr). -Example +Getting Started --- -In a folder called `myGame`, create a file called `main.lua` with this in it: +You can visit the [LÖVR website](http://bjornbyt.es/lovr) to download precompiled binaries for +windows. Once you have `lovr.exe`, create a folder called `myGame` to hold the files for your game. +Next, create a file called `main.lua` in `myGame` and put this in it: ```lua function lovr.draw(eye) @@ -19,7 +22,7 @@ function lovr.draw(eye) end ``` -Drag the `myGame` folder onto a shortcut to `lovr.exe`. You should see a spinning purple cube! +Finally, drag the `myGame` folder onto `lovr.exe`. You should see a spinning purple cube! #### 3D Models @@ -35,17 +38,26 @@ function lovr.draw() end ``` +For more examples, check out the `examples` folder. + Supported Hardware --- -- HTC Vive +- HTC Vive (full support) +- Oculus Touch (partial support) +- WebVR (partial support, see `emscripten` branch) +- Mobile VR (no support currently) -Support for other hardware will happen eventually. +Documentation +--- + +See for examples and API reference. The documentation is open source +and can be found at . Compiling --- -How to compile LÖVR from source. +How to compile LÖVR from source, for other operating systems or custom builds. ### Dependencies