From a3326d73b6d7ca480e79eb75b4b73094595073ab Mon Sep 17 00:00:00 2001 From: Stefan Boberg Date: Thu, 20 May 2021 13:19:19 +0200 Subject: Updated README.md with contribution instructions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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 -- cgit v1.2.3