aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2023-02-01 14:59:57 +0100
committerGitHub <[email protected]>2023-02-01 14:59:57 +0100
commit141cb238d0b560678b94468a7aca0e4ba9dc94c0 (patch)
treeb55daa4a0b59df0109db9938ffcabd180e46996e
parentUpdate README.md (diff)
downloadzen-141cb238d0b560678b94468a7aca0e4ba9dc94c0.tar.xz
zen-141cb238d0b560678b94468a7aca0e4ba9dc94c0.zip
Updated README.md
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 19ebb3f7d..5d8070eff 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,14 @@
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
-Zen is currently EXPERIMENTAL and not intended to be used in production. We will make breaking changes to storage and application interfaces as well as significant performance improvements in the upcoming months to make it ready for general adoption.
+Zen is currently EXPERIMENTAL and not intended to be used in production. We will make breaking changes
+to storage and application interfaces as well as significant performance improvements in the upcoming
+months to make it ready for general adoption.
Zen can also be deployed as a shared instance for use as a shared cache. It also supports upstream
-connectivity to cloud storage services as well as other Zen server instances.
+connectivity to cloud storage services as well as other Zen server instances. However, due to how
+propagation is handled this is not currently recommended as performance will be better if you use
+a hierarchical DDC graph in UE
All platforms require [xmake](https://xmake.io)
@@ -14,6 +18,10 @@ Download the latest release [here](https://github.com/xmake-io/xmake/releases)
## Building on Windows
+Windows is our primary development platform and is generally the easiest to debug and profile on. For
+debugging we recommend Visual Studio 2022 or later, and for profiling you may want to use a high
+frequency sampling profiler such as Superluminal Performance.
+
### Windows Setup
To build the code you will need Visual Studio 2022 (we use c++20 features), git and vcpkg.