From b2d78747b0d340e4ae5324513e80e2dac1449608 Mon Sep 17 00:00:00 2001
From: ALittlePatate <48603993+ALittlePatate@users.noreply.github.com>
Date: Mon, 23 Oct 2023 20:14:02 +0200
Subject: [PATCH] add readme

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..daa2ab5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# TaxiDriver
+W/RPM Driver and usermode for Linux.<br>
+Some things in the client are still not finished :
+* X11 overlay
+
+# Features
+* Get the base address of any process/loaded .so file
+* RPM
+* WPM
+
+# Compiling
+To compile the driver you'll need to be at least on kernel version v6.5.8 (i used the [arch kernel](https://github.com/archlinux/linux/releases/tag/v6.5.8-arch1)).<br>
+
+## Prerequises :
+You'll need git, linux-headers, SDL3 and OpenGL :
+```
+sudo pacman -S git linux-headers OpenGL
+yay -S sdl3-git
+```
+
+## Compiling and running :
+Clone the repo, prepare imgui (still in active dev) :
+```
+git clone https://github.com/ALittlePatate/TaxiDriver --recursive
+chmod +x prepare_imgui.sh
+./prepare_imgui.sh
+```
+Compile :
+```
+make
+```
+Run the driver :
+```
+sudo make load
+sudo dmesg | grep TaxiDriver
+```
+You should find a line saying that TaxiDriver was loaded with X major code.
+```
+sudo mknod /dev/TaxiDriver c X 0
+```
+replace X with your major code.<br>
+Run the client :
+```
+sudo ./Revird
+```
+Unload the driver :
+```
+sudo make unload
+```
+
+# Contact
+If you have a problem regarding the code, open an issue or make a pull request, i'll be happy to add your contribution !<br>
+If you need to contact me for any other reasons, message me at @_.patate on discord.