aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2021-06-09 12:19:06 +0200
committerStefan Boberg <[email protected]>2021-06-09 12:19:06 +0200
commit54dcffbe54d7732df2c04a10ad1b381d74a89daf (patch)
tree6497cec1ebf8d0fd020a84a9859af217d0669b58
parentFixed issue with ProjectStore::OplogStorage::Exists() (diff)
downloadzen-54dcffbe54d7732df2c04a10ad1b381d74a89daf.tar.xz
zen-54dcffbe54d7732df2c04a10ad1b381d74a89daf.zip
Minor README cleanup
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index a4ec951fd..5ab300fa4 100644
--- a/README.md
+++ b/README.md
@@ -50,9 +50,10 @@ Now you are ready to start building!
# Contributing Code
-We rely on clang-format for consistent code formatting. You can install version 12 or later from https://llvm.org/builds/
+To run the pre-commit scripts you'll need a few things:
-The helper scripts also depend on Python 3.x, which you may install from https://www.python.org/downloads/windows/
+* 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/ (I am presently using 3.9.5 which works). NOTE: *do* check the option to add Python to your PATH!
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