From ebf52fb418f80e782b7980d20a0073c70f4b6763 Mon Sep 17 00:00:00 2001
From: woblight <woblight@gmail.com>
Date: Fri, 21 Mar 2025 19:36:09 +0100
Subject: [PATCH] Add linux build instructions to README (#8)

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index b7c0305..061ead2 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,26 @@
 Git based World of Warcraft addon manager.
 
 This application exclusively manage git repositories, addons not containing a git repositories will be ignored. All addons hosted on Gitlab, Github and likes are compatible but must be cloned through git (if you don't know what that means, you will need to redownload your addons through this app).
+
+## Building on Linux
+
+### Requirements:
+
+- Qt Modules:
+    - Core
+    - Quick
+    - QuickControls2
+    - Concurrent
+    - Network
+    - Widgets
+- libgit2
+
+### build & install
+
+```bash
+cmake . -B build -DGitAddonsManager_GIT_DESCRIBE="$(git describe --tags --long)" -DCMAKE_BUILD_TYPE=Release --install-prefix="$(pwd)/release"
+cmake --build build
+cmake --install build
+```
+
+The executable is then found in `release/bin/`.