summarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKatelyn Schiesser2021-07-10 20:57:13 -0700
committerKatelyn Schiesser2021-07-10 21:07:40 -0700
commitdae4beafc844a30f100648fa124b621e9f6ceb82 (patch)
tree21450c74988be89de718147f89d204caa28b2ef6 /README.md
parente66bd941f4e768cd183025cc4ec3fbec79ab60c1 (diff)
downloadaur-dae4beafc844a30f100648fa124b621e9f6ceb82.tar.gz
add readme, remove old sphinx patch
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..a9c87e7814d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# linux-vfio
+
+## What is this?
+
+linux-vfio is the kernel for Arch linux, with the ACS Override and i915 VGA Arbiter patches applied. These patches, originally written by Alex Williamson and updated by Mark Weiman, allow certain motherboards to split PCIe IOMMU groups where it would not otherwise be possible. This is often used to allow a specific PCIe card (often a video card) to be assigned to the `vfio` driver, and attached to a virtual machine.
+
+## Using this repository
+
+This repository is used to track the AUR [linux-vfio](https://aur.archlinux.org/pkgbase/linux-vfio/) package, along with (hopeful) automation thereof. The official AUR repository is still hosted by Arch: https://aur.archlinux.org/cgit/aur.git/log/?h=linux-vfio
+
+## See Also
+
+https://aur.archlinux.org/pkgbase/linux-vfio/
+
+https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF
+
+https://www.kernel.org/doc/Documentation/vfio.txt