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