aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPer Larsson <[email protected]>2021-12-15 15:05:36 +0100
committerPer Larsson <[email protected]>2021-12-15 15:05:36 +0100
commite6deaea228f7c937018ed7dc74a82b351fdaab4f (patch)
treee8473df27f6e5971090fcff900112e5087b665ac
parentAdded preprocessing config file and removed Visual Studio files. (diff)
downloadzen-e6deaea228f7c937018ed7dc74a82b351fdaab4f.tar.xz
zen-e6deaea228f7c937018ed7dc74a82b351fdaab4f.zip
Updated readme.
-rw-r--r--README.md22
1 files changed, 9 insertions, 13 deletions
diff --git a/README.md b/README.md
index 0981e8af8..0e574c555 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,9 @@ connectivity to cloud storage services as well as other Zen server instances.
We currently only support building and running the server on Windows. Linux and Mac support is in progress
+All platforms require [xmake](xmake.io)
+Download the latest release [here](https://github.com/xmake-io/xmake/releases)
+
## Building on Windows
### Windows Setup
@@ -34,9 +37,9 @@ We currently require Visual Studio 2019 Version 16.10 or later. Visual Studio 20
currently building with the VS2022 toolchain has not been tested (please leave the sln/vcxproj un-upgraded).
* clone the `zen` repository if you haven't already
- * run `git clone https://github.com/EpicGames/zen.git`, or use Visual Studio integrated git to clone
- and open the repo
-* open the `zen.sln` VS solution (NOTE: you currently need to run Visual Studio in ADMIN mode since
+ * run `git clone https://github.com/EpicGames/zen.git`
+* run `xmake project -k vsxmake2019 -a x64 -y`
+* open the `vsxmake2019\zen.sln` VS solution (NOTE: you currently need to run Visual Studio in ADMIN mode since
http.sys requires elevation)
* you can now build and run `zenserver` as usual from Visual Studio
* third-party dependencies will be built the first time via the `vcpkg` integration. This is not as
@@ -45,17 +48,10 @@ currently building with the VS2022 toolchain has not been tested (please leave t
### Building with xmake
-* Install xmake from https://github.com/xmake-io/xmake/releases/tag/v2.5.7 ( later versions should also be ok)
- * Once installed you may want to update to latest using `xmake update dev` to get some bugfixes for
- scheduling compiles on very high core count workstations (this note applies to 2.5.7)
-
-You can then build from the command line:
-
-`d:\zen> xmake -y` (the `-y` is only really useful the first build when xmake prompts for vcpkg package installation confirmation)
-
-It's also possible to generate project files for Visual Studio via
+* configure xmake `xmake config -m debug|release -a x64`
+* build zenserver `xmake build zenserver`
-`d:\zen> xmake project -k vsxmake -a x64`
+Binaries are located in the `build` directory
## Building on Linux