Skip to content

Commit 10572f5

Browse files
LeiaSDK Docs
1 parent 6c41b59 commit 10572f5

9 files changed

+22
-3
lines changed

docs/_sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- **Acer SpatialLabs**
1313
- [Acer SpatialLabs Display Unlocked](guides/Acer_SpatialLabs_Display/SpatialLabs_Unlocked)
1414
- [Using OpenVR With Stereo3D Displays](guides/OpenVR/Using_OpenVR_With_Stereo3D_Displays)
15-
- [Leia SR SDK Usage Guide](guides/LeiaSDK_Usage_Guide)
15+
- [Leia SR SDK Usage Guide](guides/LeiaSDK_Usage_Guide/LeiaSDK_Usage_Guide)
1616
- **Contact**
1717
- [Email](mailto:[email protected])
1818
- [GitHub](https://github.com/AndrewHazelden)
16.4 KB
Loading
53.2 KB
Loading
178 KB
Loading
39.3 KB
Loading
60.6 KB
Loading
53.7 KB
Loading
173 KB
Loading

docs/guides/LeiaSDK_Usage_Guide.md renamed to docs/guides/LeiaSDK_Usage_Guide/LeiaSDK_Usage_Guide.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ Written by: Andrew Hazelden <[email protected]>
55

66
Step 1. Download the Spatial Reality SDK from the project's [GitHub Releases page](https://github.com/LeiaInc/LeiaSR-Windows-Releases/releases).
77

8-
Expand the zip archive contents to the root folder of the C:\ drive. (This will keep the filepaths simple when compiling the code):
8+
Expand the zip archive contents to the root folder of the C:\ drive and rename the folder to "simulatedreality-SDK":
99

1010
C:\simulatedreality-SDK\
1111

12+
(This folder name choice will keep the filepaths simple when compiling the code.)
13+
1214
SDK Reference URLs:
1315

1416
- [Leia SDK](https://support.leiainc.com/sdk)
@@ -28,6 +30,10 @@ Download the [Visual Studio 2019 community installer](https://aka.ms/vs/16/relea
2830

2931
Step 4. Create the Visual Studio solution for the "OpenGL Weaving" demo using cmake from the command prompt:
3032

33+
![VS Build](Images/opengl_weaving_command_prompt.png)
34+
35+
Enter the following shell commands:
36+
3137
cd C:\simulatedreality-SDK\examples\opengl_weaving
3238
mkdir build
3339
cd build
@@ -40,14 +46,24 @@ Step 5. Compile the code in Visual Studio
4046

4147
Change the build output from "Debug" to "Release". Then select the "Build > Build Solution" menu item.
4248

49+
![VS Build](Images/opengl_weaving_vs.png)
50+
4351
The compiled output can be found on disk at:
4452

4553
C:\simulatedreality-SDK\examples\opengl_weaving\build\Release\
4654

55+
![opengl weaving](Images/opengl_weaving_app.png)
56+
57+
![opengl weaving Command Prompt](Images/opengl_weaving_app_running.png)
58+
4759
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
4860

4961
Step 6. Create the Visual Studio solution for the "OpenGL Image Viewer" demo using cmake from the command prompt:
5062

63+
![VS Build](Images/opengl_image_viewer_command_prompt.png)
64+
65+
Enter the following shell commands:
66+
5167
cd C:\simulatedreality-SDK\examples\opengl_image_viewer
5268
mkdir build
5369
cd build
@@ -60,11 +76,14 @@ Step 5. Compile the code in Visual Studio
6076

6177
Change the build output from "Debug" to "Release". Then select the "Build > Build Solution" menu item.
6278

79+
![VS Build](Images/opengl_image_viewer_vs.png)
80+
6381
The compiled output can be found on disk at:
6482

6583
C:\simulatedreality-SDK\examples\opengl_image_viewer\build\Release\
6684

67-
When you run the example_opengl_image_viewer program the syntax is:
85+
When you run the example_opengl_image_viewer.exe program the syntax is:
6886

6987
example_opengl_image_viewer.exe "C:\Path\To\image.png"
7088

89+
![opengl image viewer Command Prompt](Images/opengl_image_viewer_app_running.png)

0 commit comments

Comments
 (0)