aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSergio Martins <smartins@kde.org>2017-07-07 20:25:27 +0100
committerSergio Martins <smartins@kde.org>2017-07-07 20:25:27 +0100
commitb2535b9144ad948da99969985d7fb14ac845bfc6 (patch)
tree751454a322fe4e40c79686076d61db40db08d3f5 /README.md
parent5bd226a783a384f28412ec5857a5038bbb49d5e8 (diff)
README: Fix formatting
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index a1b9f479..233446d2 100644
--- a/README.md
+++ b/README.md
@@ -297,15 +297,17 @@ by passing `-DCMAKE_EXPORT_COMPILE_COMMANDS` to CMake, or using [Bear](https://g
`qbs generate --generator clangdb`
-Note: Be sure the clazy-standalone binary is located in the same folder as the clang binary, otherwise it will have trouble
+**Note:** Be sure the clazy-standalone binary is located in the same folder as the clang binary, otherwise it will have trouble
finding builtin headers, like stddef.h. Alternatively, you can symlink to the folder containing the builtin headers:
(Assuming clazy was built with `-DCMAKE_INSTALL_PREFIX=/myprefix/`)
-`$ touch foo.c && clang++ '-###' -c foo.c 2>&1 | tr ' ' '\n' | grep -A1 resource`
-` "-resource-dir"`
-` "/usr/bin/../lib/clang/4.0.1"` this is the interesting path (without the version)
-`$ ln -sf /usr/bin/../lib/clang/ /myprefix/lib/clang`
+```
+$ touch foo.c && clang++ '-###' -c foo.c 2>&1 | tr ' ' '\n' | grep -A1 resource
+ "-resource-dir"
+ "/usr/bin/../lib/clang/4.0.1" # this is the interesting path (without the version)
+$ ln -sf /usr/bin/../lib/clang/ /myprefix/lib/clang
+```
`clang-tidy` support will be added after <https://bugs.llvm.org//show_bug.cgi?id=32739> is fixed.