From 1b701100efa7d6b71e14fcd8ce80cc2bb4a92e92 Mon Sep 17 00:00:00 2001
From: Joseph Aquino <joseph.aquino1997@protonmail.com>
Date: Tue, 14 Apr 2026 06:41:07 +0000
Subject: [PATCH] Update readme.md

---
 readme.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/readme.md b/readme.md
index 2845937..a762698 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,20 @@
+# A small command line app that mimics some of the basic internal commands of git
+
+## Build instructions
+### Requirements
+* CMake
+* On Windows: Visual Studio 2022 or newer
+* On Linux: Make, GCC/Clang
+### Linux 
+* Navigate to project root
+* Configure Cmake project
+<br>```cmake -B build``` 
+* Build Cmake project
+<br>```cmake --build build```
+* The executible will be in the 'bin' folder
+### Windows
+* Run the 'generate-solution.bat' file 
+* Open the Visual Studio solution file that is in the newly created 'build' folder
+* Use Visual Studio to build the project
+
 <a href="https://www.flaticon.com/free-icons/version-control" title="version control icons">Version control icons created by See Icons - Flaticon</a>
\ No newline at end of file