From 2bf8f363d6c812c7eb62f55ff9666cb16e11a43f Mon Sep 17 00:00:00 2001 From: Ronald Zielaznicki <58531251+RonaldZielaznicki@users.noreply.github.com> Date: Mon, 21 Nov 2022 13:11:58 -0500 Subject: [PATCH 1/3] Remove install step for stardust-xr It is not required to run cargo install anymore --- docs/getting-started/install.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index 1b527494..0f9f93aa 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -35,11 +35,6 @@ cd stardust-xr-server cargo build ``` -### Install -```bash -cargo install -``` - ## [Flatland](https://github.com/StardustXR/flatland) (Simple simula-like panel UI client for 2D app interaction) ### Build system -- 2.49.1 From 3e39de08b0b6d34a01996592be8f34e30d0a791e Mon Sep 17 00:00:00 2001 From: Ronald Zielaznicki <58531251+RonaldZielaznicki@users.noreply.github.com> Date: Mon, 21 Nov 2022 13:46:34 -0500 Subject: [PATCH 2/3] 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. --- docs/getting-started/starting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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) -- 2.49.1 From 959a42f3643590e56bdc1d0dc9ca85c657a871e9 Mon Sep 17 00:00:00 2001 From: Ronald Zielaznicki <58531251+RonaldZielaznicki@users.noreply.github.com> Date: Mon, 21 Nov 2022 13:55:00 -0500 Subject: [PATCH 3/3] Re-add Install step with disclaimer --- docs/getting-started/install.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index 0f9f93aa..d0d4d004 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -35,6 +35,12 @@ cd stardust-xr-server cargo build ``` +### Install +(this step isn't required. Using `cargo run` while developing is just fine) +```bash +cargo install --path . +``` + ## [Flatland](https://github.com/StardustXR/flatland) (Simple simula-like panel UI client for 2D app interaction) ### Build system -- 2.49.1