diff options
| -rw-r--r-- | README.md | 23 |
1 files changed, 13 insertions, 10 deletions
@@ -47,20 +47,12 @@ basis and requires manual bootstrap so you will need to do the following at leas Now you are ready to start building! -#### Installing pre-commit (optional) - -This is necessary to run pre-commit locally, which is useful in particular to run clang-format prior to -commit. - -* Make sure python3 is installed. Version 3.11 or later should work - * You can install using `winget install python3` -* Run `pip install pre-commit` - ### Building with Visual Studio We currently require a C++ compiler from Visual Studio 2022 or later. The following steps need to be run from a Command Prompt window or a Terminal instance +* Install Visual Studio 2022 (manually or via `winget install Microsoft.VisualStudio.2022.Professional`) * 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` or `gh repo clone EpicGames/zen` (you may want @@ -77,7 +69,7 @@ from a Command Prompt window or a Terminal instance 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 +### Building with xmake on the command line * configure xmake: `xmake config -m debug|release -a x64` * build zenserver: `xmake build zenserver` @@ -85,6 +77,17 @@ from a Command Prompt window or a Terminal instance Compiled binaries are located in the `build` directory +#### Installing pre-commit (optional) + +This is necessary to run pre-commit locally, which is useful in particular to run clang-format prior to +commit. + +* Make sure python3 is installed. Version 3.11 or later should work + * You can install using `winget install python3` +* Run `pip install pre-commit` + +Once set up, you can run precommit checks via `xmake precommit` + ## Building on Linux The following instructions have been collated using Ubuntu 20.04. |