Skip to content

Commit 8159a1c

Browse files
Update README.md
1 parent 0325228 commit 8159a1c

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,37 @@
1+
12
# Wave CloudXR Sample Client
23

3-
Demonstrate how to program with NVIDIA CloudXR SDK 3.0 for VIVE Focus 3 headset. You can start to develop your own CloudXR application for VIVE Focus 3 based on this sample client.
4+
Demonstrate how to program with NVIDIA CloudXR SDK 3.0 for VIVE Focus 3 headset. You can start to develop your own CloudXR application for VIVE Focus 3 based on this sample client.
5+
6+
Below are the instructions to build from source. Alternatively you can find a pre-built APK in the [Releases](https://github.com/ViveSoftware/Wave-CloudXR-Sample/releases) section.
47

5-
## Requirement
8+
## Requirements
69
- HTC VIVE Focus 3
710
- [Wave Native SDK 4.1.1](https://developer.vive.com/resources/vive-wave/download/latest/) or later
8-
- [NVIDIA CloudXR SDK 3.0](https://developer.nvidia.com/nvidia-cloudxr-sdk)
11+
- [CloudXR SDK 3.0](https://developer.nvidia.com/nvidia-cloudxr-sdk)
912
- [Google OBOE SDK 1.5.0](https://github.com/google/oboe/releases/tag/1.5.0)
1013
- Android development environment
1114
- Android Studio 4.0 or later
1215
- Android SDK 7.1.1 ‘Nougat’ (API level 25) or higher
1316
- Android build tools 28.0.3
1417
- Android NDK 21.4.7075529
15-
- OpenJDK 1.8n
18+
- OpenJDK 1.8n
1619

17-
## How to Build
18-
1. Download [NVIDIA CloudXR SDK 3.0](https://developer.nvidia.com/nvidia-cloudxr-sdk) and [Google OBOE SDK 1.5.0](https://github.com/google/oboe/releases/tag/1.5.0).
20+
## Build Instructions
21+
1. Download [CloudXR SDK 3.0](https://developer.nvidia.com/nvidia-cloudxr-sdk) and [Google OBOE SDK 1.5.0](https://github.com/google/oboe/releases/tag/1.5.0).
1922
2. Put ***CloudXR.aar*** and ***oboe-1.5.0.aar*** in ***[ProjectRoot]/app/libs***
2023
3. Download Wave SDK and put in ***[ProjectRoot]/repo*** (paths can be modified in ***build_sdk.gradle***)
2124
4. You are ready to build.
2225

23-
## How To Use
24-
1. Install NVIDIA CloudXR server 3.0 on your PC.
25-
2. Build Wave-CloudXR-Sample Client and install the apk to your VIVE Focus 3
26+
## Installation & Usage
27+
1. Install CloudXR server 3.0 on your PC.
28+
2. Build Wave CloudXR Sample Client and install the apk to your VIVE Focus 3
2629
3. Modify the IP address in ***CloudXRLaunchOptions.txt*** and push it into ***/sdcard*** of your VIVE Focus 3.
27-
- Please read [NVIDIA CloudXR Command-Line Options](https://docs.nvidia.com/cloudxr-sdk/usr_guide/cmd_line_options.html#command-line-options) for the format of ***CloudXRLaunchOptions.txt***)
30+
- Please read [CloudXR Command-Line Options](https://docs.nvidia.com/cloudxr-sdk/usr_guide/cmd_line_options.html#command-line-options) for the format of ***CloudXRLaunchOptions.txt***)
2831
5. Launch the apk to start streaming
2932

30-
## Note
31-
* The application requires WRITE_EXTERNAL_STORAGE permission to proceed, for loading a config file from sdcard and writing CloudXR logs.
33+
## Notes
34+
* The application requires WRITE_EXTERNAL_STORAGE permission to proceed, for loading a config file from sdcard and writing CloudXR logs.
3235
* If RECORD_AUDIO permission is denied, microphone feature will be disabled.
33-
34-
36+
>The above permission requests will be prompted in-headset on first launch. To install it with permissions granted, use the *-g* flag with *adb install*.
37+
> `adb install -g client.apk`

0 commit comments

Comments
 (0)