From dbe9b052a77230ab032df62d5f47d4b38be28508 Mon Sep 17 00:00:00 2001
From: HikariKnight <2557889+HikariKnight@users.noreply.github.com>
Date: Sun, 27 Feb 2022 19:56:39 +0100
Subject: [PATCH] update readme for public release

---
 README.md | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 215d239..b4c2577 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,15 @@
-# VFIO-enabler
+# VFIO-enabler (name pending)
 A project to simplify setting up GPU passthrough for QuickEMU and libvirt
 
-Currently this project does NO MODIFICATIONS to your system, all it does is generate the files needed for testing inside `./config/
+Currently this project does NO MODIFICATIONS to your system, all it does is generate the files needed for testing inside `./config/`
+
+You can use it by simply running
+```bash
+git clone https://github.com/HikariKnight/VFIO-enabler.git
+cd VFIO-enabler
+chmod +x ./vfio-setup
+./vfio-setup
+```
 
 ## Features
 * General warning and info about what you will be needing
@@ -9,6 +17,7 @@ Currently this project does NO MODIFICATIONS to your system, all it does is gene
 * 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.
 * Enable and configure the correct kernel modules
+* Provides you with the correct kernel arguments to add to your bootloader entry
 
 ## TODO
 * ~~Everything~~
@@ -17,9 +26,17 @@ Currently this project does NO MODIFICATIONS to your system, all it does is gene
 * ~~Tell user to enable IOMMU (VT-d/AMD-v) on their motherboard and bootloader~~
 * ~~Integrate ls-iommu and locate graphic cards and see what IOMMU group they are in~~
 ~~* Enable and configure vfio modules~~
-* Fetch the ID for the GPUs and generate the correct kernel arguments for grub and systemd-boot
+* ~~Fetch the ID for the GPUs and generate the correct kernel arguments for grub and systemd-boot~~
 * ~~Dump the GPU rom, just in case it will be needed for passthrough~~ (no rom patching planned due to complexity)
+* Get help to actually make the scripts better
 * A non hacky menu system? (I will need help by some bash wizards for this)
-* Blacklist drivers? (some cards require blacklisting as softdep is not enough)
+* Blacklist drivers? (some cards require blacklisting as softdep is not enoug`)
 * Install vendor_reset kernel module? (maybe far future)
-* Setup looking-glass? (far future maybe)
\ No newline at end of file
+* 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.
\ No newline at end of file