From 933e7442f2f674b614c082e9f936f5ec1f975493 Mon Sep 17 00:00:00 2001
From: Maxwell Jeffress <max@maxwellj.xyz>
Date: Sat, 21 Dec 2024 16:17:28 +1100
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d23a1a4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# SDL Text Input
+
+## What this does
+
+This program allows you to type into a window. Nothing more, nothing less.
+
+## Why?
+
+I started learning C++ and SDL for fun.
+
+## How do I run it?
+
+First, install a C++ compiler (like g++ from gcc), SDL2, SDL2_ttf, make and cmake. 
+
+On Arch Linux, run this command to install everything:
+
+```bash
+sudo pacman -S gcc sdl2 sdl2_ttf make cmake
+```
+
+Next, run:
+
+```bash
+mkdir build && cd build
+cmake ..
+make && ./program
+```
+
+## Credits
+
+### [SDL](https://www.libsdl.org/)
+
+The graphics library I used. Very easy and fun to learn!
+
+### [IBM Plex Mono](https://www.ibm.com/plex/)
+
+The font included in the repository. Probably my favourite monospace font.