aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Ridgers <[email protected]>2021-10-28 11:35:03 +0200
committerMartin Ridgers <[email protected]>2021-10-29 13:12:22 +0200
commit776d1a0d4b8e7d977189a71f3f001d8ae7c0ba32 (patch)
tree331080c2cdcf436497d005dc18093db3db4fba96
parentAlphebetical include order (diff)
downloadzen-776d1a0d4b8e7d977189a71f3f001d8ae7c0ba32.tar.xz
zen-776d1a0d4b8e7d977189a71f3f001d8ae7c0ba32.zip
Tweaked README.md on how to used the --mode=config xmake option
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 77dddfb80..0981e8af8 100644
--- a/README.md
+++ b/README.md
@@ -101,15 +101,17 @@ 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
+xmake config --plat=linux --cxx=g++-11 --cc=gcc-11 [--mode=debug]
```
-Now we are ready to build Zen. The `--mode=debug` is optional. It has been
-included below to show how to change build variants. The `-y` skips `xmake` from
-prompting about updating `vcpkg` packages;
+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 config --mode=debug
xmake build -y
```