diff --git a/docs/getting-started/_category_.json b/docs/getting-started/_category_.json new file mode 100644 index 00000000..84c7320c --- /dev/null +++ b/docs/getting-started/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Getting Started", + "position": 1 +} diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md new file mode 100644 index 00000000..ddcb527f --- /dev/null +++ b/docs/getting-started/install.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 2 +--- + +# Installation + +## [libstardustxr](https://github.com/StardustXR/libstardustxr) (server, client, and fusion) + +### Prerequisites +1. Meson +2. Ninja +3. Flatbuffers >= 1.12.0 + +### Download +```bash +git clone https://github.com/StardustXR/libstardustxr.git +cd libstardustxr +``` + +### Build +```bash +meson build --prefix=/usr +cd build +ninja +``` + +### Install +```bash +ninja install +``` + +## [stardust-xr](https://github.com/StardustXR/stardust-xr) (reference server) + +### Prerequisites +1. Meson >= 0.55.0 +2. Ninja +3. CMake +4. Flatbuffers >= 1.12.0 +5. EGL+GLES 3.2 +6. GLX+Xlib +7. fontconfig +8. dlopen +9. OpenXR Loader (required even if run in flatscreen mode) + +### Download +```bash +git clone https://github.com/StardustXR/stardust-xr.git +cd stardust-xr +``` + +### Build +```bash +meson build --prefix=/usr +cd build +ninja +``` + +### Install +```bash +ninja install +``` \ No newline at end of file diff --git a/docs/overview.md b/docs/getting-started/overview.md similarity index 100% rename from docs/overview.md rename to docs/getting-started/overview.md diff --git a/docs/getting-started/run.md b/docs/getting-started/run.md new file mode 100644 index 00000000..9e509777 --- /dev/null +++ b/docs/getting-started/run.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 3 +--- + +# Use + +## Server +``` +Stardust XR +Usage: stardustxr [OPTIONS] + +Options: + -h,--help Print this help message and exit + -F,--flatscreen Run Stardust in flatscreen mode + --field-debug Draw translucent meshes around fields + ``` \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index fb3312ae..bf1b505a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -33,7 +33,7 @@ module.exports = { }, { type: 'doc', - docId: 'overview', + docId: 'getting-started/overview', position: 'left', label: 'Docs', }, @@ -65,8 +65,8 @@ module.exports = { href: 'roadmap', }, { - label: 'Overview', - to: '/docs/overview', + label: 'Getting Started', + to: '/docs/getting-started/overview', }, { label: 'Protocol', diff --git a/src/pages/index.js b/src/pages/index.js index 8de8c396..6e5eeffb 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -18,8 +18,8 @@ function HomepageHeader() {