From 3fd257243cd1e107140350c1b3cda6cc034b7b48 Mon Sep 17 00:00:00 2001
From: Konstantinos Sideris <sideris.konstantin@gmail.com>
Date: Sat, 10 Feb 2018 13:46:26 +0200
Subject: [PATCH] Update build instructions

fixes #226

[ci skip]
---
 CMakeLists.txt |  3 ++-
 README.md      | 31 +++++++++++++++++--------------
 2 files changed, 19 insertions(+), 15 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 16b865cc..2997f668 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -45,7 +45,8 @@ else()
     find_package_handle_standard_args(LMDB DEFAULT_MSG LMDB_INCLUDE_DIR LMDB_LIBRARY)
 endif()
 
-if (NOT EXISTS "${CMAKE_SOURCE_DIR}/libs/lmdbxx/.git" )
+if (NOT EXISTS "${CMAKE_SOURCE_DIR}/libs/lmdbxx/.git" OR
+    NOT EXISTS "${CMAKE_SOURCE_DIR}/libs/matrix-structs/.git")
     message(WARNING "The git submodules are not available.")
     message(STATUS "Running git submodule update --init --recursive ...")
     execute_process(COMMAND git submodule update --init --recursive)
diff --git a/README.md b/README.md
index 958d88c0..cef142e0 100644
--- a/README.md
+++ b/README.md
@@ -109,19 +109,7 @@ brew install qt5 lmdb cmake llvm
 
 ### Building
 
-Clone the repo with its submodules
-
-```bash
-git clone --recursive https://github.com/mujx/nheko
-```
-or 
-```bash
-git clone https://github.com/mujx/nheko
-cd nheko
-git submodule update --init --recursive
-```
-
-and then run
+Clone the repo and run
 
 ```bash
 make release
@@ -134,7 +122,22 @@ cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=RelWithDebInfo
 cmake --build build
 ```
 
-You might need to pass `-DCMAKE_PREFIX_PATH=<< Qt install location >>` to cmake to point it at your qt5 install.
+If the build fails with the following error
+```
+Could not find a package configuration file provided by "Qt5Widgets" with
+any of the following names:
+
+Qt5WidgetsConfig.cmake
+qt5widgets-config.cmake
+```
+You might need to pass `-DCMAKE_PREFIX_PATH` to cmake to point it at your qt5 install.
+
+e.g on macOS
+
+```
+cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_PREFIX_PATH=$(brew --prefix qt5)
+cmake --build build
+```
 
 The `nheko` binary will be located in the `build` directory.