From eb2aacfbe96427e93cb6fb86a97601c52c621bf8 Mon Sep 17 00:00:00 2001
From: Ronald Zielaznicki <58531251+RonaldZielaznicki@users.noreply.github.com>
Date: Mon, 21 Nov 2022 13:57:39 -0500
Subject: [PATCH] Rewrite install step for stardust-xr (#2)

* 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
---
 docs/getting-started/install.md  | 3 ++-
 docs/getting-started/starting.md | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md
index 1b527494..d0d4d004 100644
--- a/docs/getting-started/install.md
+++ b/docs/getting-started/install.md
@@ -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)
diff --git a/docs/getting-started/starting.md b/docs/getting-started/starting.md
index 6685402b..43d2a84d 100644
--- a/docs/getting-started/starting.md
+++ b/docs/getting-started/starting.md
@@ -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)