Skip to content

Commit 8c6f3be

Browse files
committed
Added Documentation section to Readme, per Unity Asset Store submission feedback.
1 parent 5a6763d commit 8c6f3be

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

OSVR-Unity/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
> _This is an Alpha Release, and probably not entirely idiomatic for Unity. Check back for updates often._
44
5+
## Documentation
6+
For links to details, documentation, and support, visit the repository on github: https://github.com/OSVR/OSVR-Unity#readme
7+
58
## Known Issues
69
This list only includes Unity-specific issues that have a substantial impact on the development experience. For a full list of issues, see the [GitHub issue tracker](https://github.com/sensics/OSVR-Unity/issues)
710

811
- Unity 4 Free version will not use distortion as this is a Pro-only feature. You will get a warning that you can ignore and continue to use OSVR without distortion. OSVR plugins will still work with Unity 4 Free. If you get a License Error in Unity 4 Free, try moving all files from Plugins/x86 to Plugins/.
912
- Unity 5 OSVR developers should use the 32-bit version of the Unity 5 editor for now. Support for 64-bit Unity 5 is coming soon. ([GitHub issue](https://github.com/OSVR/OSVR-Unity/issues/19))
1013
- Stereo will not work unless you load a display `.json` file manually into the display prefab. A number of these are bundled with the plugin: drag and drop the appropriate one into the slot in the Inspector.
11-
- Display configuration is not always falling back to data from OSVR. ([GitHub issue](https://github.com/OSVR/OSVR-Unity/issues/2))
1214

1315
## Basic Principles and Files
1416
On a machine where you're running an OSVR-Unity application, you need to run an OSVR server, part of the OSVR-Core builds. For convenience, a 32-bit OSVR Server install is bundled in the OSVR-Unity snapshot archives. [Contact us](mailto:support@osvr.org) if you need help.

0 commit comments

Comments
 (0)