Skip to content

Commit 58cb0cc

Browse files
committed
Update readme
1 parent f1293f6 commit 58cb0cc

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

readme.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The project folders in this repo have the following dependencies:
3838

3939
6. Install official Microsoft [C/C++ VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools).
4040

41-
7. (Recommended) Disable VS Code auto updates in `File -> Preferences -> Settings` by setting `update.mode` to manual. VS Code updates on a monthly basis, and sometimes an auto-update can break the project files.
41+
7. (Recommended) Disable VS Code auto updates in `File -> Preferences -> Settings` by setting `update.mode` to manual and `extensions.autoUpdate` to None. VS Code updates on a monthly basis, and sometimes an auto-update can break the project files. Additionally, feature changes on the vscode-cpptools extension may cause instability. Tested version #s can be found on each Release page.
4242

4343
8. That's it! You're ready to start using Visual Studio Code to develop with Maxim's Microcontrollers. See Usage below.
4444

@@ -85,7 +85,7 @@ The project folders in this repo have the following dependencies:
8585

8686
7. Install official Microsoft [C/C++ VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools).
8787

88-
8. (Recommended) Disable VS Code auto updates in `File -> Preferences -> Settings` by setting `update.mode` to manual. VS Code updates on a monthly basis, and sometimes an auto-update can break the project files.
88+
8. (Recommended) Disable VS Code auto updates in `File -> Preferences -> Settings` by setting `update.mode` to manual and `extensions.autoUpdate` to None. VS Code updates on a monthly basis, and sometimes an auto-update can break the project files. Additionally, feature changes on the vscode-cpptools extension may cause instability. Tested version #s can be found on each Release page.
8989

9090
9. That's it! You're ready to start using Visual Studio Code to develop with Maxim's Microcontrollers. See Usage below.
9191
@@ -189,6 +189,8 @@ For full usage details, please refer to the [official VS Code debugger documenta
189189
190190
The default project configuration should work for most use cases as long as `"target"` and `"board"` are set correctly.
191191
192+
Any field from `settings.json` can be referenced from any other config file (including itself) with `"${config:[fieldname]}"`
193+
192194
The following configuration options are available:
193195
## Basic Config Options
194196
* `"target"`
@@ -242,6 +244,7 @@ The following configuration options are available:
242244
* `"M4_OCD_target_file"`
243245
* Sets the OpenOCD target file to use for the Arm M4 core. This should match the target microcontroller.
244246
* `.cfg` file extension must be included.
247+
* **On Linux there is a case-sensitivity issue with this setting**. OpenOCD config files are all lowercase, but `"target"` must be uppercase. On Linux, manually set this value to the lowercase target .cfg file matching the `"target"` config option. Ex: `""M4_OCD_target_file":"max32670.cfg"`
245248
* Default value: `"${config:target}.cfg"`
246249
247250
* `"RV_OCD_interface_file"`

0 commit comments

Comments
 (0)