StardustXR/website
1
0
Fork 0
Code Issues 3 Pull Requests 4 Actions Packages Projects Releases Wiki Activity

Rewrite install step for stardust-xr (#2)

Browse Source 
* Remove install step for stardust-xr

It is not required to run cargo install anymore

* Update command to cargo run

The previous step no longer asks the user to install stardust-xr-server. So they'll need to run it from cargo.

* Re-add Install step with disclaimer
This commit was merged in pull request #2.
This commit is contained in:
Ronald Zielaznicki
2022-11-21 13:57:39 -05:00
committed by GitHub
parent c73ea8a60f
commit eb2aacfbe9
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/getting-started/install.md
View File

@@ -36,8 +36,9 @@ cargo build
```
### Install
(this step isn't required. Using `cargo run` while developing is just fine)
```bash
cargo install
cargo install --path .
```
## [Flatland](https://github.com/StardustXR/flatland) (Simple simula-like panel UI client for 2D app interaction)

2
docs/getting-started/starting.md
View File

@@ -4,7 +4,7 @@ sidebar_position: 4
# Starting
First, try running `stardust-xr-server` in a terminal window. If a headset is plugged in and OpenXR is working no window will show up. However, the headset should show the same things as the window that opens:
First, try running `cargo run` in a terminal window. If a headset is plugged in and OpenXR is working no window will show up. However, the headset should show the same things as the window that opens:
![A pitch black void with a single bleach white hand in the middle](/img/docs/run/xr_mode_windowed_blank.png)