Skip to content

Commit 03c9d1b

Browse files
authored
📝 Fixup setup vscode instructions (#71)
1 parent 1ff91a7 commit 03c9d1b

2 files changed

Lines changed: 20 additions & 17 deletions

File tree

mkdocs/assets/clangd-arguments.png

35 KB
Loading

mkdocs/user_guide/setup_vscode.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,29 @@ should also work for non-vscode users as well.
1616

1717
## Setup Steps
1818

19+
Make sure you have already installed clang via the
20+
[🚀 Getting Started](../getting_started.md) guide.
21+
1922
1. Install [VSCode](https://code.visualstudio.com/) if you don't already have
2023
it installed.
21-
2. Go the the "Extensions" section on the left side bar. Hover over the icons
22-
to get their name.
23-
3. Search for "C/C++" and disable the extension if it is already installed and
24-
enabled.
24+
2. Go the the "Extensions" section on the left side bar. It looks like 4 blocks
25+
with the upper right hand block disconnected from the other 3. Hover over
26+
the icons to get their name.
27+
3. Search for "C/C++" and disable the Windows intellisense extension if it is
28+
already installed and enabled.
2529
4. Search for the extension `clangd` and install the extension.
26-
5. Install `clang`
27-
1. Ubuntu/Debian: `sudo apt install clang`
28-
2. MacOS: `brew install llvm@18`
29-
3. Windows: `choco install llvm`
30-
6. Add `--query-driver=**/g++,**/*-g++` (for Linux & Mac) or
31-
`--query-driver=**/g++.exe,**/*-g++.exe` (for Windows) to the clangd command
32-
arguments in the `clangd` settings.
33-
1. Go the the extensions page
34-
2. Find clangd and press the GEAR icon and open up settings.
35-
3. Find the settings `clangd: Arguments` and add the above code there. It is
36-
comma delimitated so you can add additional compiler patterns as well.
37-
7. On Mac change `Clangd: Path` to `/opt/homebrew/opt/llvm@18/bin/clangd` in
38-
the clangd settings menu.
30+
5. Go the the `clangd` extension settings page. Find the clangd extension and
31+
press the GEAR ⚙️ icon to open up it settings.
32+
6. Find the settings `clangd: Arguments` and add:
33+
1. Linux & Mac: `--query-driver=**/g++,**/*-g++`
34+
2. Windows: `--query-driver=**/g++.exe,**/*-g++.exe`
35+
7. On Mac change `Clangd: Path` to:
36+
1. Intel Mac 13: `/usr/local/opt/llvm@17/bin/clang++`
37+
2. All other versions: `/opt/homebrew/opt/llvm@17/bin/clangd`
38+
39+
Clangd arguments should look like this:
40+
41+
![clangd arguments](../assets/clangd-arguments.png "Clangd Arguments")
3942

4043
### Refreshing the Language Server
4144

0 commit comments

Comments
 (0)