From 5f1eaa74d19c4d67dd2a4973e3b2c8f9d5424afc Mon Sep 17 00:00:00 2001 From: Michael Speth Date: Wed, 12 Jul 2017 09:31:54 +1200 Subject: [PATCH 1/2] Added a new file for managing guides for setting up a development environment. --- Developing/Guides.md | 19 +++++++++++++++++++ README.md | 4 ++-- 2 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 Developing/Guides.md diff --git a/Developing/Guides.md b/Developing/Guides.md new file mode 100644 index 0000000..7eb3299 --- /dev/null +++ b/Developing/Guides.md @@ -0,0 +1,19 @@ +# Guides + +This document contains a list of guides for setting up a development environment for the specified platform. + +## Linux + +### Arch Linux +The following [wiki](https://wiki.archlinux.org/index.php/Virtual_reality#OSVR) has instructions for using AUR repos for setting up the environment + +### Ubuntu +The [osvr-core-ubuntu-build-script](https://bitbucket.org/monkygames/osvr-core-ubuntu-build-script) is a script that sets up a development enviroment on the host or can provision a virtual machine via vagrant to setup a development environment. + +## Windows + +### Experienced Users +The [Windows Build Environment](Developing/Windows-Build-Environment.md) contains documentation for experencied programers/users to setup a development environment on the windows platform. + +### Novice Users +The [STEAMVR-OSVR compilation for noobs](https://github.com/OSVR/SteamVR-OSVR/files/1117930/STEAMVR-OSVR.compilation.for.noobs.pdf) is a guide for novice users to setup and compile OSVR. diff --git a/README.md b/README.md index f56c694..c702f53 100644 --- a/README.md +++ b/README.md @@ -85,8 +85,8 @@ if no parameter is specified, a default file is used. - [Re-flash bootloader on OSVR HDK](Configuring/HDKBootloader.md) # Developing with OSVR -- Setting up the development environment - - [Windows](Developing/Windows-Build-Environment.md) +- Setting up a development environment + - [Guides](Developing/Guides.md) - [Directory of projects](http://osvr.github.io/contributing/) - [Doxygen-generated developer documentation of OSVR-Core](http://resource.osvr.com/docs/OSVR-Core/) - [Doxygen-generated internal documentation of OSVR-Core](http://resource.osvr.com/internal-docs/OSVR-Core-Implementation/) From 8108cad7e021abc76fccaa116401fead4b5186bc Mon Sep 17 00:00:00 2001 From: Michael Speth Date: Wed, 12 Jul 2017 09:34:12 +1200 Subject: [PATCH 2/2] Updated invalid link. --- Developing/Guides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Developing/Guides.md b/Developing/Guides.md index 7eb3299..0535668 100644 --- a/Developing/Guides.md +++ b/Developing/Guides.md @@ -13,7 +13,7 @@ The [osvr-core-ubuntu-build-script](https://bitbucket.org/monkygames/osvr-core-u ## Windows ### Experienced Users -The [Windows Build Environment](Developing/Windows-Build-Environment.md) contains documentation for experencied programers/users to setup a development environment on the windows platform. +The [Windows Build Environment](Windows-Build-Environment.md) contains documentation for experencied programers/users to setup a development environment on the windows platform. ### Novice Users The [STEAMVR-OSVR compilation for noobs](https://github.com/OSVR/SteamVR-OSVR/files/1117930/STEAMVR-OSVR.compilation.for.noobs.pdf) is a guide for novice users to setup and compile OSVR.