From 396b031d289fb698335395ab9acdcd7975c1b55a Mon Sep 17 00:00:00 2001 From: Wayne Heaney <42350981+wheaney@users.noreply.github.com> Date: Thu, 23 May 2024 10:09:08 -0700 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 422f8b4..630f70d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,9 @@ This repo contains a collection of tools to enable virtual desktop environments for gaming and productivity on Linux using supported XR glasses. This currently includes XREAL Air 1, 2, 2 Pro and VITURE One, Lite, and Pro models. -There are two installations at the moment: [Breezy GNOME](#breezy-gnome) for desktop support in GNOME Linux desktop environments, and [Breezy Vulkan](#breezy-vulkan) primarily for gaming but would work with pretty much any application that uses Vulkan rendering. +There are two installations at the moment: +* [Breezy GNOME](#breezy-gnome) for desktop support, primarily in GNOME Linux desktop environments +* [Breezy Vulkan](#breezy-vulkan) primarily for gaming but would work with pretty much any application that uses Vulkan rendering. ## Breezy GNOME Breezy GNOME is a virtual workspace solution for Linux desktops that use the GNOME desktop environment (requires GNOME 45+ on an x86_64 system); see [non-GNOME setup](#non-gnome-setup) if you want to try it without a GNOME desktop environment. It currently supports one virtual monitor and multiple physical monitors, but it will soon support multiple virtual monitors. See [upcoming features](#upcoming-features) for more improvements on the horizon. @@ -19,7 +21,7 @@ Breezy GNOME is a virtual workspace solution for Linux desktops that use the GNO 3. You'll have an application called `Breezy Desktop` installed. Launch that and follow any instructions. You will need to log out and back in at least once to get the GNOME extension working. ### Non-GNOME Setup -A workable solution (with [improvements to come](#upcoming-features)) is to use your preferred desktop environment with a GNOME window open in nested mode. To do this: +A workable solution (with some [QoL improvements needed](#upcoming-features)) is to use your preferred desktop environment with a GNOME window open in nested mode. To do this: 1. Install `gnome-shell` using your distros package manager (e.g. apt-get, pacman, dnf, etc...). This will currently only work with GNOME Shell versions 45+, so check that using `gnome-shell --version` 2. Run the [GNOME setup](#gnome-setup) steps. You shouldn't need to log out and back in since GNOME will be running nested. 3. Launch the nested GNOME Shell using `MUTTER_DEBUG_DUMMY_MODE_SPECS="1920x1080@60" dbus-run-session -- gnome-shell --nested` @@ -31,9 +33,10 @@ All controls are provided through the Breezy Desktop application. You can also c 1. Port to GNOME 43/44 2. ARM/AARCH64 build 3. Multiple virtual monitors + multiple physical monitors -4. SBS display depth -5. SBS support for 3D content -6. Port to other popular desktop environments: Cinnamon, KWin +4. Better nested support (clipboard sync, borderless window, snap window to correct display automatically) +5. SBS display depth +6. SBS support for 3D content +7. Port to other popular desktop environments: Cinnamon, KWin ## Breezy Vulkan