From bb0916aad5f1b39e965f356fc08b73aa3037ed5d Mon Sep 17 00:00:00 2001
From: Quad <contact@quad.moe>
Date: Fri, 18 Mar 2022 20:36:26 +0100
Subject: [PATCH] Write a basic README

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 670984c..f0b575d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,12 @@
 # eGPU switch script
 
-Placeholder
+Basic script that sets xorg config for an eGPU, if an eGPU is found.
+
+## Usage
+
+1. Place both `egpu.sh` and `egpu.conf` somewhere on your system. For example in `/opt/config`
+2. Edit `egpu.sh` according to the comment in the file. So it knows how to find your eGPU and where to copy the config to and from.
+3. Edit `egpu.conf` to add your GPU's PCI-E address. See [Arch wiki](https://wiki.archlinux.org/title/External_GPU#Xorg_rendered_on_eGPU,_PRIME_display_offload_to_iGPU) if you are unsure how to find your PCI-E address.
+4. Make `egpu.sh` run on boot before your display manager and xorg starts.
+
+How to run `egpu.sh` before your display manager varies from system to system. On systemd you can create a simple service while that runs it, containing `Before=<your display manager>`. On runit, it can be achieved by putting the script in `/etc/runit/core-services`.