From 9664674a384c9ce41f8638155d1c6c36d103c99e Mon Sep 17 00:00:00 2001 From: HikariKnight <2557889+HikariKnight@users.noreply.github.com> Date: Thu, 13 Apr 2023 14:06:14 +0200 Subject: [PATCH] Tell users what this project does not do --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 397149c..33158ca 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,25 @@ go mod download CGO_ENABLED=0 go build -o quickpassthrough cmd/main.go ``` +## What this project does NOT do +* Setup or configure your Virtual Machine (that is your job) +* Optimize your Virtual Machine for Passthrough (again this is your job) +* Optimize your host machine for Passthrough or Virtualization (out of this projects scope) +* Setup and configure GPU Passthrough on systems with 1 graphic card (iGPU counts as 1 Graphic Card by itself, so iGPU with another GPU will work) +* Does not configure passthrough of 3D controllers, as it will not work (this is most gaming laptops so do not even think about it). If you try run this on a laptop with a 3D controller, the "2nd GPU" will not show up.
+NOTE: This project is aimed at desktops + ## Features * Show general warning to user and inform about making a backup and general expectations * Detect if user has an amd or intel CPU and provide the correct IOMMU kernel args based on that -* Configure 2nd GPU for GPU Passthrough (1 for host, 1 for VM) +* Configure your 2nd GPU for GPU Passthrough (1 for host, 1 for VM) * Use [ls-iommu](https://github.com/HikariKnight/ls-iommu) to find PCI devices like graphic cards, usb controllers, etc and see what IOMMU group they are in * Enable and configure vfio modules (initramfs-tools, dracut, modprobe and mkinitcpio) -* Generate the correct kernel arguments for grub and systemd-boot~~ -* Generate script to use for dumping the vbios rom (as some cards require a romfile for passthrough to work), however no rom patching support planned. +* Generate the correct kernel arguments for grub and systemd-boot +* Generate a script to use for dumping the vbios rom (as some cards require a romfile for passthrough to work), however no rom patching support planned. * Configure kernel arguments for systemd-boot (using kernelstub or grubby) * Configure kernel arguments for grub2 (editing /etc/default/grub or using grubby) -* A system you can navigate through, built using [Bubble Tea](https://github.com/charmbracelet/bubbletea) (Help appreciated to make this menu better!) +* A menu system you can navigate through, built using [Bubble Tea](https://github.com/charmbracelet/bubbletea) (Help appreciated to make this menu better!) * ~~Coloured highlight/text for important information?~~ (not implemented yet) * Make sure [vendor-reset](https://github.com/gnif/vendor-reset) module is loaded before vfio, check the repository for the list of cards that require it! * Provides you with the correct kernel arguments to add to your bootloader entry if a supported bootloader is not found