From 7905cba8310052f86188cbe7ed30726d9e2f163d Mon Sep 17 00:00:00 2001 From: Stefan Boberg Date: Thu, 9 Sep 2021 13:10:18 +0200 Subject: Updated README.md --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 61da2ae82..a9930a120 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,13 @@ This is the implementation of the local storage service for UE5. It is intended to be deployed on user machines either as a daemon or launched ad hoc as required during of editor/cooker/game startup -This repo also contains a VFS prototype (zenfs) which is currently not functional, it's a prototype -which has decayed, hopefully it can be revisited at some point. - ## Setup -We currently only support building and running the server on Windows. Linux and Mac will be supported before UE5 release +We currently only support building and running the server on Windows. Linux and Mac support is in progress To build the code you will need Visual Studio 2019 (we use c++20 features), git and vcpkg. -* Install Visual Studio 2019 Version 16.9.4 or later (16.10 is recommended as it contains improvements to debug codegen which have a pretty significant impact when iterating in debug mode) +* Install Visual Studio 2019 Version 16.10 or later * Install [git](https://git-scm.com/download/win) We use vcpkg to manage some libraries. Right now it's not set up on a project local @@ -26,6 +23,11 @@ basis and requires manual bootstrap so you will need to do the following at leas Now you are ready to start building! +### Building with Visual Studio + +We currently require Visual Studio 2019 Version 16.10 or later. Visual Studio 2022 can also be used, but +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 @@ -33,7 +35,22 @@ Now you are ready to start building! 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 - fast as it could be (it does not go wide) but should only happen on the first build + fast as it could be (it does not go wide) but should only happen on the first build and will leverage + a local build cache. + +### 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 + +`d:\zen> xmake project -k vsxmake` # Implementation Notes -- cgit v1.2.3