From e73fb24422f4619b46da836fe10ec7dc831a5b18 Mon Sep 17 00:00:00 2001
From: Harvmaster <hzuccon@gmail.com>
Date: Mon, 27 Apr 2026 12:35:54 +0000
Subject: [PATCH] Add installation instruction as readme

---
 readme.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..4e607b8
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,58 @@
+# XO-CLI & XO-TUI
+
+## Installation
+
+### Full Installation
+```bash
+# Create a new directory since we are going to be pulling in engine too
+mdkir xo-terminal && cd xo-terminal
+
+# Clone the Engine Repo
+git clone git@gitlab.com:GeneralProtocols/xo/engine.git
+
+# Move into teh engine directory
+cd engine
+
+# Install the dependencies
+npm ci
+
+# Build the engine
+npm run build
+
+# Move back to the top level directory
+cd ..
+
+# Clone the CLI Repo
+git clone git@git.harvmaster.com:Harvmaster/xo-cli.git 
+
+# Move into the cli directory
+cd xo-cli
+
+# Install the dependencies
+npm ci
+
+# Build the cli
+npm run build
+```
+
+### Install globally
+
+```bash
+# (From the xo-cli directory)
+npm install -g .
+```
+
+### Run the CLI
+```bash
+# If globally installed (Not really usable if not globally installed)
+xo-cli
+```
+
+### Run the TUI
+```bash
+# If globally installed
+xo-tui
+
+# If not globally installed
+npm run dev
+```