From 3aca56edede06c30aaa44bac71eba97f1aa3eaea Mon Sep 17 00:00:00 2001 From: louib Date: Sun, 12 Jan 2020 13:02:36 -0500 Subject: [PATCH] code formatting developer doc. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6e6ebdd..e67fb59 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,13 @@ through the code properly. The `-Wall` and `-Wextra` flags enable all compiler warnings. Please submit code with zero warnings. +Also make sure that your changes are consistent with the coding style defined in the `.clang-format` file, using: +``` +make format +``` +You will need `clang-format` installed to use the `format` command. + + Once done with your coding then the released/patch/fixed code can be compiled, with all the normal optimisations, using: ```