diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 12 insertions, 2 deletions
@@ -8,6 +8,8 @@ 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 + 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) @@ -18,9 +20,9 @@ basis and requires manual bootstrap so you will need to do the following at leas * open up a command line window * create a `git`/`github` directory somewhere for you to clone repos into - * issue `git clone https://github.com/bionicbeagle/vcpkg.git` and build it using the `bootstrap-vcpkg.bat` script. This git repo is temporary and will change in the future but it should be an easy upgrade when the time comes + * issue `git clone https://github.com/microsoft/vcpkg.git` and build it using the `bootstrap-vcpkg.bat` script * optional: add the `vcpkg` directory you cloned to your PATH to allow invoking vcpkg on the command line -* issue `vcpkg integrate install` +* issue `vcpkg integrate install` to make sure you can build from Visual Studio using package manifests Now you are ready to start building! @@ -46,6 +48,14 @@ Now you are ready to start building! will be tightened up in the future to require some degree of authentication to satisfy security requirements +# Contributing Code + +We rely on clang-format for consistent code formatting. You can install version 12 or later from https://llvm.org/builds/ + +The helper scripts also depend on Python 3.x, which you may install from https://www.python.org/downloads/windows/ + +Once you have those dependencies, you can simply run `prepare_commit.bat` to ensure the code is properly formatted and has the Epic copyright header comment + # Testing * There are some test projects |