Skip to content

Commit

Permalink
🔀 Merge branch 'ladislas/feature/vscode-config-template' into develop
Browse files Browse the repository at this point in the history
* ladislas/feature/vscode-config-template:
  📝 (vscode): Add documentation about settings.template.json
  🔥 (vscode): Delete settings.json
  🔧 (vscode): Create template for settings.json
  • Loading branch information
ladislas committed Jan 21, 2022
2 parents ea3882a + bced273 commit cf8c08c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#

.vscode
!.vscode/settings.template.json
extern/mbed-os
extern/mcuboot
_build*
Expand Down
File renamed without changes.
17 changes: 14 additions & 3 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,19 @@ We use VSCode and a handful of plugins to work on LekaOS:

It is highly recommended to install them for a better experience and to make sure you comply with our coding style.

Settings for those plugins are shared in the repos and should not be modified.
### Settings

To configure autocompletion and code checking using `clangd`, simply run `make config_tools` in your terminal. And then in VSCode, run `CMake: Configure`.
Settings for those plugins are shared in the repos as template files.

💡 **Apple Silicon** - If you're working on an Apple Silicon computer, you'll need to edit the `clangd` settings in [`.vscode/settings.json`](.vscode/settings.json) and comment/uncomment the `--query-driver=/path/to/arm-none-eadi-*` lines.
To create a local copy of the settings and configure the differents plugins and tools, you must run the following:

```bash
cp .vscode/settings.template.json .vscode/settings.json
```

Then, to configure autocompletion and code checking using `clangd`:

- run `make config_tools` in your terminal
- in VSCode, run `CMake: Configure` from the `Command Palette` (with `Cmd ⌘ + Shift ⇧ + P`)

💡 **Apple Silicon** - If you're working on an Apple Silicon computer, you'll need to edit the `clangd` settings in your local copy of `.vscode/settings.json` and comment/uncomment the `--query-driver=/path/to/arm-none-eadi-*` lines.

0 comments on commit cf8c08c

Please sign in to comment.