2019-05-23 20:19:37 +10:00
|
|
|
# Looking Glass
|
|
|
|
|
|
2020-01-31 21:43:58 +11:00
|
|
|
An extremely low latency KVMFR (KVM FrameRelay) implementation for guests with
|
|
|
|
|
VGA PCI Passthrough.
|
2017-12-14 16:32:05 +11:00
|
|
|
|
2020-12-22 10:15:34 -05:00
|
|
|
* Project Website: https://looking-glass.io
|
2021-05-25 06:00:40 -04:00
|
|
|
* Documentation: https://looking-glass.io/docs
|
2019-05-23 16:08:22 +10:00
|
|
|
|
2019-05-23 20:13:41 +10:00
|
|
|
## Documentation
|
|
|
|
|
|
2021-05-24 10:47:21 -04:00
|
|
|
❕❕❕ **IMPORTANT** ❕❕❕
|
|
|
|
|
|
2020-01-31 21:43:58 +11:00
|
|
|
This project contains submodules that must be checked out if building from the
|
2020-10-08 19:39:14 +11:00
|
|
|
git repository! If you are not a developer and just want to compile Looking
|
2021-05-24 10:34:37 -04:00
|
|
|
Glass, please download the source archive from the website instead:
|
2020-10-08 19:39:14 +11:00
|
|
|
|
2020-12-22 10:15:34 -05:00
|
|
|
https://looking-glass.io/downloads
|
2020-01-31 21:43:58 +11:00
|
|
|
|
2021-05-25 06:00:40 -04:00
|
|
|
Source code for the documentation can be found in the `/doc` directory.
|
2021-05-07 02:42:38 -04:00
|
|
|
|
|
|
|
|
You may view this locally as HTML by running `make html` with `python3-sphinx`
|
2021-12-26 03:40:41 +02:00
|
|
|
and `python3-sphinx-rtd-theme` installed.
|
