diff options
| author | Stefan Boberg <[email protected]> | 2023-02-01 14:45:36 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-02-01 14:45:36 +0100 |
| commit | 2e2594519c28c559d9f02cfd4838454995079f33 (patch) | |
| tree | 7dd8f69658395a6c0b5b9581380f57f416c347dc | |
| parent | added `xmake sln` task which replaces `generate_projects.bat` (diff) | |
| download | zen-2e2594519c28c559d9f02cfd4838454995079f33.tar.xz zen-2e2594519c28c559d9f02cfd4838454995079f33.zip | |
Update README.md
| -rw-r--r-- | README.md | 15 |
1 files changed, 6 insertions, 9 deletions
@@ -34,16 +34,16 @@ Now you are ready to start building! ### Building with Visual Studio -We currently require Visual Studio 2022 or later. +We currently require Visual Studio 2022 or later. The following steps need to be run from a Command Prompt window or a Terminal instance -* clone the `zen` repository if you haven't already +* clone the `zen` repository if you haven't already. This requires a valid github login and you need to be part of the EpicGames organization * run `git clone https://github.com/EpicGames/zen.git` -* run `xmake project -k vsxmake2022 -a x64 -y` -* open the `vsxmake2022\zen.sln` VS solution +* run `xmake sln` or `xmake project -k vsxmake2022 -a x64 -y` to generate a Visual Studio solution file +* open the `vsxmake2022\zen.sln` VS solution (`start vsxmake2022\zen.sln`) * Note: if you want full connectivity with the http.sys server implementation you currently need to run Visual Studio in ADMIN mode since http.sys requires elevation to be able to listen on a non-local network socket. You can start Visual Studio in admin mode by holding CTRL-SHIFT when launching Visual Studio. Alternatively - you can add an URL reservation (see below) + you can add an URL reservation (see below) * 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 and will leverage @@ -193,10 +193,7 @@ xmake build # Implementation Notes * The implementation currently depends only on a few libraries including the C++ standard library -* It uses exceptions for errors -* It is currently not portable as it uses Windows APIs directly. But as we all know, there is no - portable code, just code that has been ported many times. The plan is to implement support for - MacOS and Linux soon, and some research to enable it has been done +* It uses exceptions for certain types of unexpected error conditions * `zenservice.exe` currently requires elevated access to enable `http.sys` access. This will be relaxed in the future by offering to use a portable server interface without elevation * The service endpoints are currently open on all NICs and will respond to requests from any host. This |