aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/ryml/CONTRIBUTING.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2025-11-07 14:49:13 +0100
committerGitHub Enterprise <[email protected]>2025-11-07 14:49:13 +0100
commit24e43a913f29ac3b314354e8ce5175f135bcc64f (patch)
treeca442937ceeb63461012b33a4576e9835099f106 /thirdparty/ryml/CONTRIBUTING.md
parentget oplog attachments (#622) (diff)
downloadzen-24e43a913f29ac3b314354e8ce5175f135bcc64f.tar.xz
zen-24e43a913f29ac3b314354e8ce5175f135bcc64f.zip
switch to xmake for package management (#611)
This change removes our dependency on vcpkg for package management, in favour of bringing some code in-tree in the `thirdparty` folder as well as using the xmake build-in package management feature. For the latter, all the package definitions are maintained in the zen repo itself, in the `repo` folder. It should now also be easier to build the project as it will no longer depend on having the right version of vcpkg installed, which has been a common problem for new people coming in to the codebase. Now you should only need xmake to build. * Bumps xmake requirement on github runners to 2.9.9 to resolve an issue where xmake on Windows invokes cmake with `v144` toolchain which does not exist * BLAKE3 is now in-tree at `thirdparty/blake3` * cpr is now in-tree at `thirdparty/cpr` * cxxopts is now in-tree at `thirdparty/cxxopts` * fmt is now in-tree at `thirdparty/fmt` * robin-map is now in-tree at `thirdparty/robin-map` * ryml is now in-tree at `thirdparty/ryml` * sol2 is now in-tree at `thirdparty/sol2` * spdlog is now in-tree at `thirdparty/spdlog` * utfcpp is now in-tree at `thirdparty/utfcpp` * xmake package repo definitions is in `repo` * implemented support for sanitizers. ASAN is supported on windows, TSAN, UBSAN, MSAN etc are supported on Linux/MacOS though I have not yet tested it extensively on MacOS * the zencore encryption implementation also now supports using mbedTLS which is used on MacOS, though for now we still use openssl on Linux * crashpad * bumps libcurl to 8.11.0 (from 8.8.0) which should address a rare build upload bug
Diffstat (limited to 'thirdparty/ryml/CONTRIBUTING.md')
-rw-r--r--thirdparty/ryml/CONTRIBUTING.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/thirdparty/ryml/CONTRIBUTING.md b/thirdparty/ryml/CONTRIBUTING.md
new file mode 100644
index 000000000..c8e847bfa
--- /dev/null
+++ b/thirdparty/ryml/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# Contributing
+
+Thanks for your contribution!
+
+* Make sure to clone the project with `git clone --recursive` so that
+ the submodules are initialized correctly.
+* To enable both tests and benchmarks, configure ryml with `-DRYML_DEV=ON`
+ when calling cmake. To enable only tests, use `-DRYML_BUILD_TESTS=ON`; to
+ enable only benchmarks use `-DRYML_BUILD_BENCHMARKS=ON`. All these flags
+ are disabled by default.
+* Code style for pull requests should respect the existing code style:
+ ```c++
+ if(foo) // no space before parens
+ { // curly brackets on next line
+ // no tabs; indent with 4 spaces
+ bar();
+ }
+ ```