mirrors/quickpassthrough
1
0
Fork 0
mirror of https://github.com/HikariKnight/quickpassthrough.git synced 2024-09-19 11:28:46 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Some markdown linting

Browse source 
only one "problem" left. Replacing unneeded '<br>' with two spaces
aids readability without changing rendered html
This commit is contained in:
Phil 2022-03-03 19:16:24 +00:00
parent f559cdaf3e
commit d016b1f292
1 changed files with 16 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,10 +1,12 @@
# VFIO-enabler (name pending)
A project to simplify setting up GPU passthrough for [QuickEMU](https://github.com/quickemu-project/quickemu) and libvirt
Currently this project does NO MODIFICATIONS to your system, all it does is generate the files needed for testing inside `./config/`<br>
Currently this project does **NO MODIFICATIONS** to your system, all it does is generate the files needed for testing inside `./config/`
In a future version it will ask if you want changes applied to your system, however I am not enabling that until I have confirmation that this generates a working configuration for other systems than my own.
You can use it by simply running
```bash
git clone https://github.com/HikariKnight/VFIO-enabler.git
cd VFIO-enabler
@ -12,6 +14,7 @@ cd VFIO-enabler
```
## Features
* General warning and info about what you will be needing
* Enable and configure vfio modules
* Configure 2nd GPU for GPU Passthrough
@ -20,17 +23,19 @@ cd VFIO-enabler
* Provides you with the correct kernel arguments to add to your bootloader entry
## Contributing
<img src="https://user-images.githubusercontent.com/2557889/156038229-4e70352f-9182-4474-8e32-d14d3ad67566.png" width="250px"><br>
I know my bash skills are not great, so help is always welcome! And help is wanted here.<br>
If you know bash well, you will be able to help! Just make a pull request with your changes!<br>
Just remember to add comments to document the work and explain it for people who are less familiar with the bash syntax or anything else you use. 😄<br>
<br>
Also if you know english, you can just help proof reading. English is not my native language, plus I have dyslexia so I often make spelling mistakes.<br>
<img src="https://user-images.githubusercontent.com/2557889/156038229-4e70352f-9182-4474-8e32-d14d3ad67566.png" width="250px">
I know my bash skills are not great, so help is always welcome! And help is wanted here.
If you know bash well, you will be able to help! Just make a pull request with your changes!
Just remember to add comments to document the work and explain it for people who are less familiar with the bash syntax or anything else you use. 😄
Also if you know english, you can just help proof reading. English is not my native language, plus I have dyslexia so I often make spelling mistakes.
Proof reading is still contribution!
## TODO
* ~~Everything~~
* ~~Everything
* ~~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~~
* ~~Tell user to enable IOMMU (VT-d/AMD-v) on their motherboard and bootloader~~
@ -45,9 +50,10 @@ Proof reading is still contribution!
* Install vendor_reset kernel module? (maybe far future)
* Setup looking-glass? (far future maybe)
<br>
----
### Why bash?
I wanted the dependencies to be minimal without the need for compilation and not have a potential breaking change in the future (like with the transition from python2 to python3).
I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang.