looking-glass/README.md

23 lines
686 B
Markdown
Raw Normal View History

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
* Project Website: https://looking-glass.io
2021-05-25 10:00:40 +00:00
* Documentation: https://looking-glass.io/docs
## 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
git repository! If you are not a developer and just want to compile Looking
Glass, please download the source archive from the website instead:
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.
You may view this locally as HTML by running `make html` with `python3-sphinx`
2021-05-25 10:00:40 +00:00
installed.