Updated documentation for easier onboarding of developers and users #19
Assignees
MayaTheShy
Clear assignees
MayaTheShy
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: StardustXR/website#19
Reference in New Issue
Block a user
Delete Branch "main"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Created a landing page for a more basic description of what Stardust XR is. Added a QuickStart guide that directs the user a simple way to more quickly test out basic functionality in a 2D window. Updated the guide for setting up OpenXR Runtime to have many more resources. Added a Full Installation guide with more resources for installation and setup. Added a full walkthrough for Meta Quest users that includes verbose instructions.
@@ -0,0 +1,12 @@---Remove this because we already establish these points in the previous paragraph
You should get a contributor guide kinda like what we have on UM, see: https://wiki.ultramarine-linux.org/en/contributing/contributorguide/
@@ -0,0 +1,67 @@---@@ -0,0 +1,92 @@---@@ -0,0 +18,4 @@Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using an Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora (with RPMFusion) or Ultramarine, this command will install the driver:```sudo dnf install akmod-nvidia@@ -0,0 +21,4 @@sudo dnf install akmod-nvidiasudo akmods# Wait for this to finish before rebooting, this may take up to 15 minutes```Add a note about secure boot, this is often a papercut
https://wiki.ultramarine-linux.org/en/setup/post-advanced/#set-up-secure-boot
@@ -0,0 +1,89 @@---@@ -0,0 +1,76 @@---@@ -4,7 +4,7 @@ const darkCodeTheme = require("prism-react-renderer/themes/vsDark");/** @type {import('@docusaurus/types').DocusaurusConfig} */@@ -0,0 +1,12 @@---Not sure why
linuxwas on there?@@ -0,0 +1,67 @@---@@ -0,0 +29,4 @@Other Fedora Editions can directly install terra-release:```sudo dnf install --nogpgcheck --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' terra-release```Add how to install on immutable versions of Fedora and its derivatives.
Here is what the terra docs say (make non-immutable on top though, then add back the part I removed in the previous line to encompass both ways to install):
Fedora Atomic Editions
On Immutable editions of Fedora, run the following command:
curl -fsSL https://github.com/terrapkg/subatomic-repos/raw/main/terra.repo | pkexec tee /etc/yum.repos.d/terra.repo
sudo rpm-ostree install terra-release
Other Fedora Editions
Directly install terra-release:
sudo dnf install --nogpgcheck --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' terra-release
Will finish my review later
@@ -0,0 +1,12 @@---think including from implies that there's stardust exclusive 2d apps (which i don't believe there are
@@ -0,0 +1,12 @@---mayb typo
@@ -0,0 +1,12 @@---at least hyphenate
Feels weird to have quickstart, talking about telescope and such, before manual, which talks about how to install the packages. Also, might wanna say that group installing stardust, etc. will pull in telescope.
@@ -0,0 +1,92 @@---@@ -0,0 +1,12 @@---I don't believe there are at the moment but there certainly can and probably will be
@@ -0,0 +1,92 @@---Right, in discussion with Nova about this Telescope is a little redundant with the full installation, as the startup script essentially launches the same things if you set it up that way. I believe Nova's intention with telescope is a bit of a bundled demo. I'm going to be looking into making a submodule repo and make all of these installs more organized.
@@ -0,0 +1,76 @@---Sometimes the guide says in, sometimes the guide says install. Should say install everywhere to be consistent.
@@ -0,0 +1,12 @@---rm one of these empty lines
@@ -0,0 +57,4 @@From here, just run `telescope -f` for flatscreen mode in your terminal!You will see a floating hexagon with the Stardust XR logo in the center, this is Hexagon Launcher.rm one of the empty lines
@@ -0,0 +5,4 @@# Setup OpenXR RuntimeThis guide will help you set up your VR or AR headset for use with Stardust. Although support for many headsets on Linux is still under active development, there are a number of good options available. If you already have OpenXR set up on your Linux distribution, head to the [Full Installation](manual) page to get Stardust XR installed.rm one empty line
@@ -0,0 +66,4 @@<img src="/img/docs/nixos.svg" alt="Logo" style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }} />NixOS</h3>rm one empty line
@@ -0,0 +70,4 @@On NixOS, it's generally easiest to follow the instructions at https://lvra.gitlab.io/docs/distros/nixos/ as Envision is currently unstable on NixOS and troubleshooting SteamVR can be tricky.### Other options for installationYou can also download the [Envision AppImage](https://gitlab.com/gabmus/envision/-/pipelines?ref=main&status=success). Once downloaded, unzip the archive, you should find a file named Envision-x86_64.AppImage. You can do this from the properties menu in your file manager, or run `chmod +x Envision-x86_64.AppImage` in your terminal.rm two empty lines
@@ -0,0 +18,4 @@```The setup video is done with a Meta Quest 3, and with [Ultramarine](https://ultramarine-linux.org/download/), a Fedora based distribution. Ultramarine comes with the Terra repository pre-installed. You can follow [these instructions](https://wiki.ultramarine-linux.org/en/setup/getting/) to install a version of Ultramarine.:::rm one empty line