diff options
Diffstat (limited to 'dist/clangformat/README.md')
| -rw-r--r-- | dist/clangformat/README.md | 22 |
1 files changed, 4 insertions, 18 deletions
diff --git a/dist/clangformat/README.md b/dist/clangformat/README.md index 05fd065c01..26982360ae 100644 --- a/dist/clangformat/README.md +++ b/dist/clangformat/README.md @@ -1,6 +1,6 @@ # .clang-format for Qt Creator -Alongside this file you find an EXPERIMENTAL .clang-format configuration file +In you Qt Creator root there is an EXPERIMENTAL .clang-format configuration file for the Qt Creator code base. The current configuration is useful, but not fully in accordance with the @@ -26,25 +26,11 @@ For more information about clang-format, see ## Set up Qt Creator for use with clang-format -### Install the configuration file - -For a given source file to format, clang-format it will read the configuration -from .clang-format in the closest parent directory for the file to format. - -Hence symlink/copy .clang-format from this directory to e.g. Qt Creator's top -level directory: - -For Linux/macOS: - - $ cd $QTC_SOURCE - $ ln -s dist/clangformat/.clang-format - -For Windows: +### Configure Qt Creator - $ cd $QTC_SOURCE - $ copy dist\clangformat\.clang-format # Do not forget to keep this updated + 0. Enable experimental ClangFormat plugin to get C++ indentation based on it. -### Configure Qt Creator + Or use an alternative way: 1. Enable the Beautifier plugin and restart to load it. |