aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Ridgers <[email protected]>2022-01-13 14:10:38 +0100
committerMartin Ridgers <[email protected]>2022-01-13 14:10:38 +0100
commita3a8205cc0dbcf44a2a774b204e4e9805e3bbc31 (patch)
tree200b89f2a44aeab49f16a4c6e3b027d00ef5fdf0
parentBe explicit about what platforms a block implements for grepability (diff)
downloadzen-a3a8205cc0dbcf44a2a774b204e4e9805e3bbc31.tar.xz
zen-a3a8205cc0dbcf44a2a774b204e4e9805e3bbc31.zip
Added instructions for building on Mac
-rw-r--r--README.md35
1 files changed, 27 insertions, 8 deletions
diff --git a/README.md b/README.md
index 0e574c555..57e43b62e 100644
--- a/README.md
+++ b/README.md
@@ -97,25 +97,44 @@ Clone the Zen project and tell `xmake` to use the correct GCC version;
```
git clone https://github.com/EpicGames/zen.git ~/zen/main
cd ~/zen/main
-xmake config --plat=linux --cxx=g++-11 --cc=gcc-11 [--mode=debug]
```
-The `--mode=debug` is optionally required to change the build variant. This
-cannot be done when executing the build and the setting of configuration options
-can not be composed across multiple `xmake config` calls.
-
Now we are ready to build Zen. The `-y` skips `xmake` from prompting about
updating `vcpkg` packages;
```
-xmake build -y
+xmake config -y --mode=debug
+xmake build
```
-The `xmake` flags `-vD` can be useful to diagnose `xmake` issues.
+Note that the command above to set the build variant to debug is optional. Tests
+are only built in debug.The `xmake` flags `-vD` can be useful to diagnose
+`xmake` issues.
## Building on Mac
-... coming soon
+Building on Mac is very similar to Linux; install xmake, clone vcpkg and Zen and
+then build the project. Here is a short summary;
+
+```
+## vcpkg
+git clone https://github.com/microsoft/vcpkg.git ~/zen/vcpkg
+~/zen/vcpkg/bootstrap-vcpkg.sh
+~/zen/vcpkg/vcpkg --version
+
+## xmake
+curl -L https://github.com/xmake-io/xmake/releases/download/v2.6.2/xmake-v2.6.2.macosx.pkg > xmake-v2.6.2.macosx.pkg
+sudo installer -pkg xmake-v2.6.2.macosx.pkg -target /
+
+## Zen
+git clone https://github.com/EpicGames/zen.git ~/zen/main
+cd ~/zen/main
+
+## Build
+export VCPKG_ROOT=~/zen/vcpkg
+xmake config -y --mode=debug --arch=x86_64
+xmake build
+```
# Implementation Notes