Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/create_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,14 @@ Continue to [build the project](./build_run.md).
top-level folder in VS Code (**File - Open Folder...**).
- Ready-to-run examples are available on [GitHub](https://github.com/Arm-Examples#keil-mdk-version-6-examples).

## Open existing solution

If you want to open an existing solution, go to **File - Open Folder...** and select the folder that contains the
`vcpkg-configuration.json` and/or `*.csolution.yml` file.

If you want to use the [VS code workspace](https://code.visualstudio.com/docs/editing/workspaces/workspaces) feature,
you can also use **File - Add Folder to Workspace...**.

## Configure a solution

The **Configure Solution** view opens automatically, if:
Expand Down
Binary file added docs/images/add-arm-tools-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/arm-tools-zero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 9 additions & 2 deletions docs/tipsandtricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@ This chapter contains useful information to help you solve specific issues.

## Create vcpkg configuration file

If your solution does not contain the `vcpkg-configuration.json`, right-click anywhere in the workspace and select
**Configure Arm Tools Environment**. The **Arm Tools Environment Manager** extension then generates this file.
If your solution does not contain a `vcpkg-configuration.json` file, click on
![Arm Tools: 0](./images/arm-tools-zero.png) in the status bar and then on
![Add Arm Tools Configuration](./images/add-arm-tools-config.png)

The **Arm Tools Environment Manager** extension creates this file and opens the GUI view. Select the tools you want to
use in your project (at least a compiler toolchain, cmake, and Ninja). Use the latest versions available if you do not
have specific version requirements.

Switch to the JSON file view and press **Ctrl/Cmd+s** to save the file.

## Set current solution in workspace

Expand Down
13 changes: 10 additions & 3 deletions site/create_app.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@
</li>
<li class="toctree-l2"><a class="reference internal" href="#github-repositories">GitHub repositories</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#open-existing-solution">Open existing solution</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#configure-a-solution">Configure a solution</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#software-components-and-packs">Software components and packs</a>
Expand Down Expand Up @@ -201,7 +203,7 @@ <h1 id="work-with-cmsis-solutions">Work with CMSIS solutions</h1>
<h2 id="examples">Examples</h2>
<ol>
<li>Click the <strong>Target Board (Optional)</strong> drop-down list.</li>
<li>Enter a search term tp filter the list and then select your board. The details of the selected board are displayed.</li>
<li>Enter a search term to filter the list and then select your board. The details of the selected board are displayed.</li>
<li>Click <strong>Select</strong>.</li>
</ol>
<p>Next, select the example project. There are two types of example projects (available either from <strong>Local</strong> packs and/or
Expand All @@ -222,7 +224,7 @@ <h2 id="examples">Examples</h2>
activate the workspace and download the tools specified in the <code>vcpkg-configuration.json</code> file included in a
project.</p>
</div>
<p>A typical Blinky example includes a <code>REAMDE.md</code> file that contains valuable information about the hardware setup and
<p>A typical Blinky example includes a <code>README.md</code> file that contains valuable information about the hardware setup and
specific tasks that need to be done before working with the target board:</p>
<p><img alt="Alif E7 Blinky-HP example" src="images/blinky-hp.png" /></p>
<p>Continue to <a href="build_run.html">build the project</a>.</p>
Expand Down Expand Up @@ -336,6 +338,11 @@ <h2 id="github-repositories">GitHub repositories</h2>
<li>Ready-to-run examples are available on <a href="https://github.com/Arm-Examples#keil-mdk-version-6-examples">GitHub</a>.</li>
</ul>
</div>
<h2 id="open-existing-solution">Open existing solution</h2>
<p>If you want to open an existing solution, go to <strong>File - Open Folder...</strong> and select the folder that contains the
<code>vcpkg-configuration.json</code> and/or <code>*.csolution.yml</code> file.</p>
<p>If you want to use the <a href="https://code.visualstudio.com/docs/editing/workspaces/workspaces">VS code workspace</a> feature,
you can also use <strong>File - Add Folder to Workspace...</strong>. </p>
<h2 id="configure-a-solution">Configure a solution</h2>
<p>The <strong>Configure Solution</strong> view opens automatically, if:</p>
<ul>
Expand Down Expand Up @@ -433,7 +440,7 @@ <h4 id="validation">Validation</h4>
<ol>
<li>Either click on <img alt="Issue icon" src="images/issue-icon.png" /> and select the issue in the pop-up box (a) or</li>
<li>Click the "Resolve" button for access to the pop-up box (a).</li>
<li>Once a components with validation issues is opened, you can use the "eye" icon to see which component is
<li>Once a component with validation issues is opened, you can use the "eye" icon to see which component is
missing/affected (b).</li>
<li>Use the "Apply" button to select the missing components (only available if there is no choice between different
components available).</li>
Expand Down
4 changes: 2 additions & 2 deletions site/featureroadmap.html
Original file line number Diff line number Diff line change
Expand Up @@ -598,11 +598,11 @@ <h3 id="debug-probe-support">Debug probe support</h3>
<tbody>
<tr>
<td>&#128994; <a href="debug.html#debug-adapter-support">Debug probes</a></td>
<td>ULINK2/UILNKplus support</td>
<td>ULINK2/ULINKplus support</td>
</tr>
<tr>
<td>&#128993; Debug probes</td>
<td>UILNKpro support</td>
<td>ULINKpro support</td>
</tr>
<tr>
<td>&#128994; <a href="debug.html#debug-adapter-support">Debug probes</a></td>
Expand Down
Binary file added site/images/add-arm-tools-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/images/arm-tools-zero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -272,5 +272,5 @@ <h2 id="revision-history">Revision history</h2>

<!--
MkDocs version : 1.6.1
Build Date UTC : 2026-02-27 11:11:19.285038+00:00
Build Date UTC : 2026-03-03 12:41:08.944688+00:00
-->
4 changes: 2 additions & 2 deletions site/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ <h2 id="set-up-a-new-workspace">Set up a new workspace</h2>
<h3 id="tool-installation">Tool installation</h3>
<p>Required tools (such as a compiler toolchain or the CMSIS-Toolbox) are installed via the
<strong>Arm Tools Environment Manager</strong>, controlled by the <code>vcpkg-configuration.json</code> file.</p>
<p>Open the <strong>Arm Tools Environment Manager</strong> via the command pallette (Ctrl/Cmd + Shift + p) and select
<p>Open the <strong>Arm Tools Environment Manager</strong> via the command palette (Ctrl/Cmd + Shift + p) and select
<strong>Arm Tools: Configure Arm Tools Environment</strong>. The "Arm Registry" opens:</p>
<p><img alt="Arm Registry" src="images/arm-registry.png" /></p>
<p>Select at least an "Arm CMSIS-Toolbox" version as this is required to be able to <a href="#pack-installation">install packs</a>.
Expand Down Expand Up @@ -282,7 +282,7 @@ <h2 id="configure-the-extension">Configure the extension</h2>
</tr>
<tr>
<td>Probe-ID</td>
<td>Specufy the unique identifier of a probe to be used for debugging.</td>
<td>Specify the unique identifier of a probe to be used for debugging.</td>
</tr>
<tr>
<td>Use Web Services</td>
Expand Down
2 changes: 1 addition & 1 deletion site/search/search_index.json

Large diffs are not rendered by default.

Binary file modified site/sitemap.xml.gz
Binary file not shown.
9 changes: 7 additions & 2 deletions site/tipsandtricks.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,13 @@
<h1 id="tips-and-tricks">Tips and tricks</h1>
<p>This chapter contains useful information to help you solve specific issues.</p>
<h2 id="create-vcpkg-configuration-file">Create vcpkg configuration file</h2>
<p>If your solution does not contain the <code>vcpkg-configuration.json</code>, right-click anywhere in the workspace and select
<strong>Configure Arm Tools Environment</strong>. The <strong>Arm Tools Environment Manager</strong> extension then generates this file.</p>
<p>If your solution does not contain a <code>vcpkg-configuration.json</code> file, click on
<img alt="Arm Tools: 0" src="images/arm-tools-zero.png" /> in the status bar and then on
<img alt="Add Arm Tools Configuration" src="images/add-arm-tools-config.png" /></p>
<p>The <strong>Arm Tools Environment Manager</strong> extension creates this file and opens the GUI view. Select the tools you want to
use in your project (at least a compiler toolchain, cmake, and Ninja). Use the latest versions available if you do not
have specific version requirements.</p>
<p>Switch to the JSON file view and press <strong>Ctrl/Cmd+s</strong> to save the file.</p>
<h2 id="set-current-solution-in-workspace">Set current solution in workspace</h2>
<p>To activate a solution in the <strong>Solution</strong> outline view, use the <strong>Select Active Solution from workspace</strong> option in
<strong>Views and More Actions</strong>:<br />
Expand Down
2 changes: 1 addition & 1 deletion site/userinterface.html
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ <h3 id="configuration-wizard">Configuration Wizard</h3>
<img alt="Open Preview" src="images/open-conf-wiz-view-icon.png" /> in the top right corner of the file window.</p>
<p>The view will be opened next to the original source file. You can switch back pressing the <strong>Show Source</strong> button
<img alt="Open source file view" src="images/open-source-file-view-icon.png" />.</p>
<p><img alt="RTE_Device.h file in configuration wizard view" src="images/rte-devce-config-wiz-view.png" /></p>
<p><img alt="RTE_Device.h file in configuration wizard view" src="images/rte-device-config-wiz-view.png" /></p>
<h2 id="status-bar">Status bar</h2>
<p>The VS Code status bar displays information about the status of your development environment and the project.</p>
<ul>
Expand Down
Loading