summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorKonstantinos Sideris <sideris.konstantin@gmail.com>2018-02-05 14:12:07 +0200
committerKonstantinos Sideris <sideris.konstantin@gmail.com>2018-02-05 14:12:07 +0200
commitb6c39abcb45180b29d8b1f4f20cf20350a2ef6c9 (patch)
treefd8e486091ababc5fbcf24c24e0728add94fe60e /README.md
parentHandle case with no available rooms (diff)
downloadnheko-b6c39abcb45180b29d8b1f4f20cf20350a2ef6c9.tar.xz
Update build instructions (#226)
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4e20cfca..3f3a26d3 100644
--- a/README.md
+++ b/README.md
@@ -101,16 +101,13 @@ export CC=clang-3.6 CXX=clang++-3.6
 
 On Ubuntu 14.04 Trusty, it's possible to use GCC 4.9.4+, but it is not recommended, because it requires installing GCC packages from third-party PPAs.  Later versions of Ubuntu that come with GCC 4.9.4+ should work with GCC out-of-the-box.
 
-##### OSX (Xcode 8 or later)
+##### macOS (Xcode 8 or later)
 
 ```bash
 brew update
-brew install qt5 lmdb
+brew install qt5 lmdb cmake llvm
 ```
 
-N.B. you will need to pass `-DCMAKE_PREFIX_PATH=/usr/local/opt/qt5`
-to cmake to point it at your qt5 install (tweaking the path as needed)
-
 ### Building
 
 Clone the repo with its submodules
@@ -131,6 +128,15 @@ and then run
 make release
 ```
 
+which invokes cmake and translates to
+
+```bash
+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.
+
 The `nheko` binary will be located in the `build` directory.
 
 #### Nix