From 12d899a3373026c40081a915a8c3c6a34cc35461 Mon Sep 17 00:00:00 2001
From: Filippo Scognamiglio <flscogna@gmail.com>
Date: Tue, 25 Jan 2022 14:48:43 +0100
Subject: [PATCH] Created Build Instructions (macOS) (markdown)

---
 Build-Instructions-(macOS).md | 43 +++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 Build-Instructions-(macOS).md

diff --git a/Build-Instructions-(macOS).md b/Build-Instructions-(macOS).md
new file mode 100644
index 0000000..24f6735
--- /dev/null
+++ b/Build-Instructions-(macOS).md
@@ -0,0 +1,43 @@
+# Build Instructions (macOS)
+
+Let's build it from source on macOS.
+
+## Dependencies
+
+Let's start by downloading them from the official website: https://qt-project.org/downloads
+
+You should install the latest LTS version of Qt5 and export them in your path like this:
+
+```
+export PATH=~/Qt/5.15.2/clang_64/bin/:$PATH
+```
+
+## Compile
+
+Let's clone and build the project:
+
+```bash
+
+# Get it from GitHub
+git clone --recursive https://github.com/Swordfish90/cool-retro-term.git
+cd cool-retro-term
+
+# Build the proejct
+qmake -config release
+make -j8
+
+# Copy the required dependencies in to the app
+mkdir cool-retro-term.app/Contents/PlugIns
+cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns
+
+# Have fun!
+open cool-retro-term.app
+```
+
+## Assemble a DMG file
+
+If you want to export a suitable DMG file, just run this command:
+
+```
+macdeployqt cool-retro-term.app -qmldir=app/qml -dmg
+```