diff options
| author | Dan Engelbrecht <[email protected]> | 2025-09-15 19:24:12 +0200 |
|---|---|---|
| committer | GitHub Enterprise <[email protected]> | 2025-09-15 19:24:12 +0200 |
| commit | 0d82b7ccf6513ba46f9c7d3f99f0aa7946e8c1e8 (patch) | |
| tree | a41aa0254963f77b7a96e18a3e1c5fe79262997a /README.md | |
| parent | new in-memory storage strategy for oplogs (#490) (diff) | |
| download | zen-0d82b7ccf6513ba46f9c7d3f99f0aa7946e8c1e8.tar.xz zen-0d82b7ccf6513ba46f9c7d3f99f0aa7946e8c1e8.zip | |
update readme with required vcpkg version (#496)
- Improvement: Updated README.md to state the required version vcpkg
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 17 insertions, 8 deletions
@@ -33,12 +33,13 @@ To build the code you will need Visual Studio 2022 (we use c++20 features), git #### Installing vcpkg -We use vcpkg to manage some libraries. Right now it's not set up on a project local -basis and requires manual bootstrap so you will need to do the following at least once: +Some of Zen's third party dependencies are provided by Microsoft's `vcpkg` +C++ library manager. The Zen codebase currently requires vcpkg to use the 2024.03.25 release so make sure to clone/check out that version. +After cloning the project there is an initialisation step. * open up a command line window * create a `git`/`github` directory somewhere for you to clone repos into - * issue `git clone https://github.com/microsoft/vcpkg.git` and build it using the `bootstrap-vcpkg.bat` script + * issue `git clone --depth 1 --branch 2024.03.25 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` to make sure xmake and Visual Studio can locate the vcpkg install @@ -55,10 +56,12 @@ from a Command Prompt window or a Terminal instance * run `git clone https://github.com/EpicGames/zen.git` or `gh repo clone EpicGames/zen` (you may want to use `gh` to log in to github as well) * run `xmake sln` or `xmake project -k vsxmake2022 -a x64 -y` to generate a Visual Studio solution file -* upgrade vcpkg and third party libraries if necessary due to changes in library versions +* upgrade vcpkg and third party libraries to version `2024.03.25` if necessary due to changes in library versions * Update vcpkg * pushd ..\vcpkg - * git pull + * git fetch + * git clean -xdff + * git checkout 2024.03.25 * bootstrap-vcpkg.bat * popd * Upgrade the thirdparty libraries managed for the solution by vcpkg @@ -144,10 +147,11 @@ sudo apt-get install build-essential zip pkg-config ``` Some of Zen's third party dependencies are provided by Microsoft's `vcpkg` -C++ library manager. After cloning the project there is an initialisation step. +C++ library manager. The Zen codebase currently requires vcpkg to use the 2024.03.25 release so make sure to clone/check out that version. +After cloning the project there is an initialisation step. ``` -git clone https://github.com/microsoft/vcpkg.git ~/zen/vcpkg +git clone --depth 1 --branch 2024.03.25 https://github.com/microsoft/vcpkg.git ~/zen/vcpkg ~/zen/vcpkg/bootstrap-vcpkg.sh ~/zen/vcpkg/vcpkg --version ``` @@ -202,8 +206,13 @@ then build the project. You will also need to install Xcode or Xcode command lin tools. ### vcpkg + +Some of Zen's third party dependencies are provided by Microsoft's `vcpkg` +C++ library manager. The Zen codebase currently requires vcpkg to use the 2024.03.25 release so make sure to clone/check out that version. +After cloning the project there is an initialisation step. + ``` -git clone https://github.com/microsoft/vcpkg.git ~/zen/vcpkg +git clone --depth 1 --branch 2024.03.25 https://github.com/microsoft/vcpkg.git ~/zen/vcpkg ~/zen/vcpkg/bootstrap-vcpkg.sh ~/zen/vcpkg/vcpkg --version ``` |