aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2023-03-07 15:00:28 +0100
committerGitHub <[email protected]>2023-03-07 15:00:28 +0100
commit28ed9533d5f50a68c2daf97a43dacc2c58a33d8b (patch)
tree5b04a0261d2536cc3b97553710c894185575dc19 /README.md
parentstore cache rawhash and rawsize for unstructured cache values (#234) (diff)
downloadzen-28ed9533d5f50a68c2daf97a43dacc2c58a33d8b.tar.xz
zen-28ed9533d5f50a68c2daf97a43dacc2c58a33d8b.zip
removed catch2 (#241)
removed catch2 since it's de facto not supported due to the lack of multithreading support
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 44dd4a542..89bf42d6c 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,14 @@ 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
+* Run `pip install pre-commit`
+
### Building with Visual Studio
We currently require Visual Studio 2022 or later. The following steps need to be run from a Command Prompt window or a Terminal instance
@@ -227,7 +235,7 @@ is incredibly handy. When that is installed you may enable auto-attach to child
* `zencore-test` exercises unit tests in the zencore project
* `zenserver-test` exercises the zen server itself (functional tests)
-The tests are implemented using [doctest](https://github.com/onqtam/doctest), which is similar to Catch in usage. We now also support [catch2](https://github.com/catchorg/Catch2)
+The tests are implemented using [doctest](https://github.com/onqtam/doctest), which is similar to Catch in usage.
# Adding a http.sys URL reservation (Windows only)