From ca4fa2aeabb6c8de0db8d6a743527539c557c2ce Mon Sep 17 00:00:00 2001
From: itycodes <tranquillitycodes@proton.me>
Date: Tue, 5 Nov 2024 10:44:38 +0100
Subject: [PATCH] Added a readme file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a2f0fc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+WIP Rust modules for Intel GPUs.
+
+Possibly outdated docs at https://itycodes.org/doc/intel_gpu/ .
+
+Structure:
+- `src/uapi`:
+    low-level ioctl bindings
+- `src/uapi/i915`
+    low-level ioctl bindings specific to i915
+- `src/gpu`
+    low-level OOP wrapper around the ioctl bindings
+- `src/gpu/i915`
+    low-level OOP wrapper around the i915-specific ioctl bindings
+