[docs] guide: document current Looking Glass features

This commit is contained in:
Geoffrey McRae
2026-08-11 19:18:17 +10:00
parent 45429681a0
commit 33bdc611d8
36 changed files with 2356 additions and 1328 deletions

View File

@@ -1,12 +1,27 @@
# Looking Glass
An extremely low latency KVMFR (KVM FrameRelay) implementation for guests with
VGA PCI Passthrough.
Looking Glass lets you use a Windows virtual machine from Linux with very low
display and input latency. The current recommended setup uses the Looking Glass
Indirect Display Driver (IDD) in the Windows guest and the Looking Glass Client
on the Linux host.
* Project Website: https://looking-glass.io
* Documentation: https://looking-glass.io/docs
## Documentation
## Start here
The Linux client is currently distributed as source code and must be built
before it can be installed. The end-user guide covers the complete process:
1. Build the Linux client.
2. Configure shared memory for the virtual machine.
3. Install the Looking Glass IDD in Windows.
4. Install and run the client.
See the [Looking Glass documentation](https://looking-glass.io/docs) for the
current requirements and setup guide.
## Source archives
❕❕❕ **IMPORTANT** ❕❕❕
@@ -16,7 +31,7 @@ Glass, please download the source archive from the website instead:
https://looking-glass.io/downloads
Source code for the documentation can be found in the `/doc` directory.
Source code for the documentation can be found in the `doc` directory.
You may view this locally as HTML by running `make html` with `python3-sphinx`
and `python3-sphinx-rtd-theme` installed.