From f5c7ce8557354a8d031f36179f7863f02322e3d6 Mon Sep 17 00:00:00 2001
From: Pasha Bibko <156938226+PashaBibko@users.noreply.github.com>
Date: Mon, 21 Jul 2025 21:27:08 +0100
Subject: [PATCH] Updated README.md

Added build instructions
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index 732a9f2..a604c59 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
 # LXC
+
+LXC is a compiler to compile .lx files into .c files. LX is a custom langauge that I have developed,
+the documentation for the language (and compiler) can be found [here WIP](https://www.youtube.com/watch?v=xvFZjo5PgG0).
+
+### Build
+
+```
+git clone https://github.com/PashaBibko/LXC.git LXC
+cd LXC
+mkdir -p build
+cd build
+cmake ..
+cmake --build .
+```
+
+##### Windows
+
+The .exe will be located in the LXC/(Debug or Release) folder.
+
+##### UNIX based
+
+The outputted binary will be located in the LXC folder.
+
+##### Other
+
+Operating systems that are not listed above are not supported. To run the code you will have to modify it yourself.
+All code that should need to be changed is within the [Common folder](https://github.com/PashaBibko/LXC/tree/main/Common).
+https://www.youtube.com/watch?v=Xx-NcqmveDc
\ No newline at end of file