Update install instructions and feature list

This commit is contained in:
HikariKnight 2022-03-11 08:57:58 +01:00 committed by GitHub
parent 0d02fc6bc9
commit e193d8cf19
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,4 +1,4 @@
# VFIO-enabler (name pending) # QuickPassthrough
A project to simplify setting up GPU passthrough on your Linux host for [QuickEMU](https://github.com/quickemu-project/quickemu)(vfio support not developed yet) and libvirt/virt-manager A project to simplify setting up GPU passthrough on your Linux host for [QuickEMU](https://github.com/quickemu-project/quickemu)(vfio support not developed yet) and libvirt/virt-manager
@ -7,8 +7,8 @@ Currently this project works with systems using initramfs-tools, if you want sup
You can use it by simply running You can use it by simply running
```bash ```bash
git clone https://github.com/HikariKnight/VFIO-enabler.git git clone https://github.com/HikariKnight/quickpassthrough.git
cd VFIO-enabler cd quickpassthrough
./vfio-setup ./vfio-setup
``` ```
@ -18,8 +18,10 @@ cd VFIO-enabler
* Enable and configure vfio modules * Enable and configure vfio modules
* Configure 2nd GPU for GPU Passthrough * Configure 2nd GPU for GPU Passthrough
* Dump the selected GPU rom (as some cards require a romfile for passthrough to work), however no rom patching support planned. * Dump the selected GPU rom (as some cards require a romfile for passthrough to work), however no rom patching support planned.
* Enable and configure the correct kernel modules * Enable and configure the correct kernel modules and load them early (initramfs-tools only for now)
* Provides you with the correct kernel arguments to add to your bootloader entry * Configure kernel arguments for systemd-boot (using kernelstub)
* Configure kernel arguments for grub2
* Provides you with the correct kernel arguments to add to your bootloader entry if a supported bootloader is not found
## Contributing ## Contributing