From 2e8673cefd5dcd1d059c7e41aab1502991ed789b Mon Sep 17 00:00:00 2001
From: David Lazarescu <69865187+DavidLazarescu@users.noreply.github.com>
Date: Sun, 5 Nov 2023 12:39:18 +0100
Subject: [PATCH] Added macos build guide
---
README.md | 43 +++++++++++++++++++++++++++++++++++++++++--
1 file changed, 41 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 9c3c373bf..eb039eb0e 100644
--- a/README.md
+++ b/README.md
@@ -227,5 +227,44 @@ Here are some things to keep in mind during the build process.
-## For macOS
-Support coming soon!
+## For MacOS
+
+### Prerequisites
+- cmake (https://cmake.org/download)
+- make (http://ftp.gnu.org/gnu/make)
+- g++ (https://gcc.gnu.org)
+- python3 (https://www.python.org/downloads)
+- Qt 6.5 (https://www.qt.io/download-open-source)
+
+### Installation
+The installation is straight forward, just follow the steps below:
+
+
+
+1. Clone the repository.
+ ```sh
+ git clone https://github.com/Librum-Reader/Librum.git --recursive
+ ```
+2. Step into the cloned project folder.
+ ```sh
+ cd Librum
+ ```
+3. Create the build folder and step into it.
+ ```sh
+ mkdir build-Release
+ cd build-Release
+ ```
+4. Run cmake.
+ ```sh
+ cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH= ..
+ ```
+ Set `CMAKE_PREFIX_PATH` to your Qt installation path. Installing Qt via the online installer usually installs it to `/Users//Qt//macos`
+6. Build the project
+ ```sh
+ cmake --build . -j $(nproc)
+ ```
+7. Install Librum
+ ```sh
+ cmake --install .
+ ```
+