Permalink
Browse files

Add notes on Mac compilation

  • Loading branch information...
1 parent fb1dfbd commit d166ebc04f646b4da578405b0aecb651f151571c @baldurk committed Feb 6, 2017
Showing with 13 additions and 0 deletions.
  1. +13 −0 CONTRIBUTING.md
View
@@ -36,6 +36,10 @@ make -C build
Configuration is available for cmake, [documented elsewhere](https://cmake.org/documentation/). You can override the compiler with environment variables `CC` and `CXX`, and there are some options you can toggle in the root CMakeLists files such as `cmake -DENABLE_GL=OFF`.
+### Mac
+
+Mac support is pretty early and while it will compile, it's not usable for debugging yet. Builds happen with cmake the same way as Linux.
+
# Code of Conduct
I want to ensure that anyone can contribute to RenderDoc with only the next bug to worry about. For that reason the project has adopted the [contributor covenent](CODE_OF_CONDUCT.md) as a code of conduct to be enforced for anyone taking part in RenderDoc development. If you have any queries in this regard you can get in touch with me [directly over email](mailto:baldurk@baldurk.org).
@@ -122,6 +126,15 @@ sudo pacman -S libx11 libxcb xcb-util-keysyms mesa libgl qt5-base qt5-x11extras
If you know the required packages for another distribution, please share (or pull request this file!)
+### Mac
+
+Mac requires a recent version of CMake, and the same Qt version as the other platforms (at least 5.6.2). If you're using [homebrew](http://brew.sh) then this will do the trick:
+
+```
+brew install cmake qt5
+brew link qt5 --force
+```
+
# Where to Start
There are always plenty of things to do, if you'd like to chip in! Check out the [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap) page in the wiki for future tasks to tackle, or have a look at the [issues](https://github.com/baldurk/renderdoc/issues) for outstanding bugs. I'll try and tag things that seem like small changes that would be a good way for someone to get started with.

0 comments on commit d166ebc

Please sign in to comment.