Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2026-11-06 11:57:20 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

[doc] quickstart: Cleanup

Browse Source
This commit is contained in:
Jonathan Rubenstein
2026-10-08 02:20:29 +03:00
committed by Geoffrey McRae
parent de617eef73
commit 97e6df54c9
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/quickstart.rst
View File

@@ -6,12 +6,12 @@ Quick start
This is the shortest path to a current Looking Glass installation. It assumes This is the shortest path to a current Looking Glass installation. It assumes
that KVM/QEMU and the Windows guest are already working. that KVM/QEMU and the Windows guest are already working.
1. :doc:`Check the requirements <requirements>`. 1. :doc:`Check the requirements </requirements>`.
2. :ref:`Download and build the Linux client <build_client_section>`. Current 2. :doc:`Download and build the Linux client </build>`. Current
releases are not provided as Linux distribution packages. releases are not provided as Linux distribution packages.
3. :doc:`Configure KVMFR and IVSHMEM <install_libvirt>` for the largest guest 3. :doc:`Configure KVMFR and IVSHMEM <install_libvirt>` for the largest guest
resolution you intend to use. resolution and framerate you intend to use.
4. :doc:`Install the matching Looking Glass IDD <install_idd>` inside the 4. :doc:`Install the Looking Glass IDD <install_idd>` inside the
Windows guest. Install the bundled IVSHMEM driver when required. Windows guest. Install the bundled IVSHMEM driver when required.
5. :doc:`Install the client <install_client>` from its build directory. 5. :doc:`Install the client <install_client>` from its build directory.
6. Start the Windows guest, then run: 6. Start the Windows guest, then run:
@@ -25,8 +25,8 @@ otherwise uses ``/dev/shm/looking-glass``. If your path differs, select it with
``-f`` or ``lgmp:shmDevice``. ``-f`` or ``lgmp:shmDevice``.
The first connection should show the virtual Looking Glass display created by The first connection should show the virtual Looking Glass display created by
the IDD. If it does not, follow :doc:`the no-display checks the IDD. If it does not, follow :doc:`the no-display checks <troubleshooting>`
<troubleshooting>` before changing performance settings. before changing performance settings.
.. note:: .. note::

2
doc/requirements.rst
View File

@@ -66,7 +66,7 @@ The IDD does not require a physical display or dummy plug: it creates a virtual
Windows monitor, including on systems without a passed-through display output. Windows monitor, including on systems without a passed-through display output.
A physical display, dummy plug or another virtual monitor is only required A physical display, dummy plug or another virtual monitor is only required
when using the :doc:`Legacy Host Application <legacy_host>`, because that when using the :doc:`Legacy Host Application </legacy_host>`, because that
application captures an existing Windows display. application captures an existing Windows display.
.. _igpu_kvmfr_recommended: .. _igpu_kvmfr_recommended: