From f3f9b983e81f81c8bfcb6c1d1679a16d9fb1d88e Mon Sep 17 00:00:00 2001
From: "Bryan J." <132493975+chkpwd@users.noreply.github.com>
Date: Sat, 22 Feb 2025 15:53:27 -0500
Subject: [PATCH] docs: add installation instructions

The instructions are tailored to Ubuntu/Debian for a Pi Zero W that is headless. Please let me know if you would like me to rebase changes.
---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index e8aea37..e15d69b 100644
--- a/README.md
+++ b/README.md
@@ -67,6 +67,42 @@ Feel free to email comments, suggestions, or inquiries directly to andrewchilx@g
 - An *'idle mode'* can be enabled to display the Lumon logo screensaver.
 - The user can navigate the full grid using arrow and zoom keys.
 
+## Install
+```
+# Clone Repository
+git clone https://github.com/andrewchilicki/LumonMDR
+
+# Install CMake
+sudo apt install g++ cmake
+
+# Create build directory and navigate to it
+cd LumonMDR && \
+   mkdir build && cd build
+
+# Generate build files and compile
+cmake .. && make
+
+# Copy LumonMDR and navigate back
+cp LumonMDR .. && cd ..
+```
+> [!NOTE]  
+> See below, ff using a headless Pi with Raspbian LiteOS, you may require additional dependecies.
+
+<details closed>
+<summary>Installation Instructions (Debia/Ubuntu)</summary>
+
+To install the required dependencies, run the following:
+
+```bash
+sudo apt-get install libglfw3-dev libglew-dev libxinerama-dev libxxf86vm-dev libxcursor-dev
+```
+
+Additionally, set the DISPLAY variable
+```bash
+export DISPLAY=:0
+```
+</details>
+
 ---
 ---