Skip to content

Commit

Permalink
Update User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake-Carter committed Jul 13, 2021
2 parents bbae949 + 3f96c5a commit fd7cd9c
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions userguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,13 @@ OpenOCD handles flashing firmware and opening up a debugger _server_. It handle
Now that we have some understanding of the toolchain, let's see how we can integrate it into Visual Studio Code.

## Integrating the Toolchain
Visual Studio Code provides the [Tasks](https://code.visualstudio.com/Docs/editor/tasks) for integrating external tools. To use the Maxim SDK toolchain via Tasks, the toolchain binaries must be made accessible from the command line. Additionally, the correct board and peripheral driver files for a target platform must be loaded for compilation and source code development. When those conditions are met, then Tasks can be created to conveniently implement the features that you would expect from an IDE: building, cleaning, flashing, and debugging.
Visual Studio Code provides the [Tasks](https://code.visualstudio.com/Docs/editor/tasks) interface for integrating external tools. To use the Maxim SDK toolchain via Tasks, the toolchain binaries must be made accessible from the command line. Additionally, the correct board and peripheral driver files for a target platform must be loaded for compilation and source code development. When those conditions are met, then Tasks can be created to conveniently implement the features that you would expect from an IDE: building, cleaning, flashing, and debugging.

<<<<<<< HEAD
[VSCode-Maxim](https://github.com/MaximIntegratedTechSupport/VSCode-Maxim) handles this for you and offers simple, clear configuration options for changing the target platform. It leverages the fact that VS Code load settings from a `.vscode` folder inside its working directory. The `.vscode` folder in the repo makes the toolchain accessible from the integrated terminal and contains the core Tasks for use with a project Makefile. It also configures the debugger and Intellisense properly.
=======
[VSCode-Maxim](https://github.com/MaximIntegratedTechSupport/VSCode-Maxim) handles this for you and offers simple, clear configuration options for changing the target platform. It leverages the fact that VS Code will look for a `.vscode` folder inside of its working directory to load settings from. The `.vscode` folder in this repo makes the toolchain accessible from the integrated terminal and contains the core Tasks for use with a project Makefile. It also configures the debugger and Intellisense properly.
>>>>>>> 3f96c5ac77027e6eec19d89e42b925ef34390bbe
Let's get started setting it up. The procedure below is a demonstration for the MAX32670EVKIT, but the same procedure can apply to all micros.

Expand Down Expand Up @@ -250,4 +254,4 @@ The implementation file for the correct die-type of the microcontroller needs to

![GPIO Implementation File](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/gpio_init_implementation.JPG)

Using this method you can quickly and easily reference example code for your own applications.
Using this method you can quickly and easily reference example code for your own applications.

0 comments on commit fd7cd9c

Please sign in to comment.