From 698959d6000e6584eed62c4da2b6147de1c9a653 Mon Sep 17 00:00:00 2001 From: Creak Date: Thu, 14 Oct 2021 15:39:29 -0400 Subject: [PATCH] add clang-format package for Fedora --- Contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Contributing.md b/Contributing.md index 0bbd1aa..915939c 100644 --- a/Contributing.md +++ b/Contributing.md @@ -12,7 +12,7 @@ When generating the native build script for your toolset, cmake will try to find * Windows: do nothing; cmake will download a pre built binary for MSVC and MINGW. MSVC users can additionally install a clang format Visual Studio extension to add features like format on save. * macOS: run `brew install clang-format`. -* Linux: use your package manager to get an appropriate binary. +* Linux: use your package manager to get an appropriate binary (e.g. on Fedora: `sudo dnf install clang-tools-extra`). If clang format is found, then cmake will add a custom build target that can be run at any time to run clang format against *all* source files and update the formatting in them. This should be used before making a pull request so that the reviewers can spend more time reviewing the code instead of having to worry about minor style violations. On MSVC, you can run clang format by building the clang-format project in the solution. On macOS, you can either use the Makefile target `make clang-format` or by building the clang-format target in XCode. For Makefile builds, you can use the clang-format target with `make clang-format`