aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2021-05-20 13:19:19 +0200
committerGitHub <[email protected]>2021-05-20 13:19:19 +0200
commita3326d73b6d7ca480e79eb75b4b73094595073ab (patch)
treee7e28f3294ce138645860fda3667dffa0d7843fb
parentUpdate README.md (diff)
downloadzen-a3326d73b6d7ca480e79eb75b4b73094595073ab.tar.xz
zen-a3326d73b6d7ca480e79eb75b4b73094595073ab.zip
Updated README.md with contribution instructions
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 89733d5fe..42220e382 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,14 @@ Now you are ready to start building!
will be tightened up in the future to require some degree of authentication to satisfy security
requirements
+# Contributing Code
+
+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/
+
+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
+
# Testing
* There are some test projects