Skip to content

Commit 4550eaf

Browse files
committed
Extend Visual Studio Code related documentation
1 parent f29c25c commit 4550eaf

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

Diff for: README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,24 @@ up-to-date later on.
167167
For a debug build, use `-DCMAKE_BUILD_TYPE=Debug`. To tweak various settings (e.g. warnings) for development,
168168
use `-DENABLE_DEVEL_DEFAULTS=ON`.
169169

170-
To use `clangd` via Visual Studio Code, specify `-DCMAKE_EXPORT_COMPILE_COMMANDS=1`. Then link the
171-
`compile_commands.json` file from the build directory into the source directory. When using the `subdirs`
172-
project you can create a symlink to the subdirs project in the individual projects (e.g.
170+
#### Using Visual Studio Code
171+
172+
##### clangd
173+
To use `clangd` via Visual Studio Code install the
174+
[extension](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) and
175+
add `-DCMAKE_EXPORT_COMPILE_COMMANDS=1` to the CMake arguments. Then link the `compile_commands.json` file
176+
from the build directory into the source directory. When using the `subdirs` project you can create a symlink
177+
to the subdirs project in the individual projects (e.g.
173178
`compile_commands.json -> ../subdirs/syncthingtray/compile_commands.json`) and a symlink to the actual build
174179
directory in the subdirs project (e.g.
175180
`compile_commands.json -> /…/build/presets/syncthingtray/arch-android-x86_64/compile_commands.json`).
176181

182+
##### Qt
183+
To work on my C++ projects that use Qt it might be useful to install their
184+
[extension pack](https://marketplace.visualstudio.com/items?itemName=TheQtCompany.qt). This requires the
185+
"vscode marketplace" which might not be available in all distributions of Visual Studio Code (e.g. when
186+
using the Arch Linux `code` package one needs to install the `code-marketplace` package in addition).
187+
177188
#### CMake presets
178189
There are some generic [presets](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html) available.
179190

0 commit comments

Comments
 (0)