Skip to content

Commit e751f36

Browse files
authored
Merge pull request #40 from MDK-Packs/docs4cube2
Updates for external tool
2 parents cf504a7 + de83d1c commit e751f36

15 files changed

+41
-14
lines changed

docs/create_app.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,14 @@ Continue to [build the project](./build_run.md).
173173
top-level folder in VS Code (**File - Open Folder...**).
174174
- Ready-to-run examples are available on [GitHub](https://github.com/Arm-Examples#keil-mdk-version-6-examples).
175175

176+
## Open existing solution
177+
178+
If you want to open an existing solution, go to **File - Open Folder...** and select the folder that contains the
179+
`vcpkg-configuration.json` and/or `*.csolution.yml` file.
180+
181+
If you want to use the [VS code workspace](https://code.visualstudio.com/docs/editing/workspaces/workspaces) feature,
182+
you can also use **File - Add Folder to Workspace...**.
183+
176184
## Configure a solution
177185

178186
The **Configure Solution** view opens automatically, if:
9.89 KB
Loading

docs/images/arm-tools-zero.png

1.65 KB
Loading

docs/tipsandtricks.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@ This chapter contains useful information to help you solve specific issues.
44

55
## Create vcpkg configuration file
66

7-
If your solution does not contain the `vcpkg-configuration.json`, right-click anywhere in the workspace and select
8-
**Configure Arm Tools Environment**. The **Arm Tools Environment Manager** extension then generates this file.
7+
If your solution does not contain a `vcpkg-configuration.json` file, click on
8+
![Arm Tools: 0](./images/arm-tools-zero.png) in the status bar and then on
9+
![Add Arm Tools Configuration](./images/add-arm-tools-config.png)
10+
11+
The **Arm Tools Environment Manager** extension creates this file and opens the GUI view. Select the tools you want to
12+
use in your project (at least a compiler toolchain, cmake, and Ninja). Use the latest versions available if you do not
13+
have specific version requirements.
14+
15+
Switch to the JSON file view and press **Ctrl/Cmd+s** to save the file.
916

1017
## Set current solution in workspace
1118

site/create_app.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@
7070
</li>
7171
<li class="toctree-l2"><a class="reference internal" href="#github-repositories">GitHub repositories</a>
7272
</li>
73+
<li class="toctree-l2"><a class="reference internal" href="#open-existing-solution">Open existing solution</a>
74+
</li>
7375
<li class="toctree-l2"><a class="reference internal" href="#configure-a-solution">Configure a solution</a>
7476
</li>
7577
<li class="toctree-l2"><a class="reference internal" href="#software-components-and-packs">Software components and packs</a>
@@ -201,7 +203,7 @@ <h1 id="work-with-cmsis-solutions">Work with CMSIS solutions</h1>
201203
<h2 id="examples">Examples</h2>
202204
<ol>
203205
<li>Click the <strong>Target Board (Optional)</strong> drop-down list.</li>
204-
<li>Enter a search term tp filter the list and then select your board. The details of the selected board are displayed.</li>
206+
<li>Enter a search term to filter the list and then select your board. The details of the selected board are displayed.</li>
205207
<li>Click <strong>Select</strong>.</li>
206208
</ol>
207209
<p>Next, select the example project. There are two types of example projects (available either from <strong>Local</strong> packs and/or
@@ -222,7 +224,7 @@ <h2 id="examples">Examples</h2>
222224
activate the workspace and download the tools specified in the <code>vcpkg-configuration.json</code> file included in a
223225
project.</p>
224226
</div>
225-
<p>A typical Blinky example includes a <code>REAMDE.md</code> file that contains valuable information about the hardware setup and
227+
<p>A typical Blinky example includes a <code>README.md</code> file that contains valuable information about the hardware setup and
226228
specific tasks that need to be done before working with the target board:</p>
227229
<p><img alt="Alif E7 Blinky-HP example" src="images/blinky-hp.png" /></p>
228230
<p>Continue to <a href="build_run.html">build the project</a>.</p>
@@ -336,6 +338,11 @@ <h2 id="github-repositories">GitHub repositories</h2>
336338
<li>Ready-to-run examples are available on <a href="https://github.com/Arm-Examples#keil-mdk-version-6-examples">GitHub</a>.</li>
337339
</ul>
338340
</div>
341+
<h2 id="open-existing-solution">Open existing solution</h2>
342+
<p>If you want to open an existing solution, go to <strong>File - Open Folder...</strong> and select the folder that contains the
343+
<code>vcpkg-configuration.json</code> and/or <code>*.csolution.yml</code> file.</p>
344+
<p>If you want to use the <a href="https://code.visualstudio.com/docs/editing/workspaces/workspaces">VS code workspace</a> feature,
345+
you can also use <strong>File - Add Folder to Workspace...</strong>. </p>
339346
<h2 id="configure-a-solution">Configure a solution</h2>
340347
<p>The <strong>Configure Solution</strong> view opens automatically, if:</p>
341348
<ul>
@@ -433,7 +440,7 @@ <h4 id="validation">Validation</h4>
433440
<ol>
434441
<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>
435442
<li>Click the "Resolve" button for access to the pop-up box (a).</li>
436-
<li>Once a components with validation issues is opened, you can use the "eye" icon to see which component is
443+
<li>Once a component with validation issues is opened, you can use the "eye" icon to see which component is
437444
missing/affected (b).</li>
438445
<li>Use the "Apply" button to select the missing components (only available if there is no choice between different
439446
components available).</li>

site/featureroadmap.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -598,11 +598,11 @@ <h3 id="debug-probe-support">Debug probe support</h3>
598598
<tbody>
599599
<tr>
600600
<td>&#128994; <a href="debug.html#debug-adapter-support">Debug probes</a></td>
601-
<td>ULINK2/UILNKplus support</td>
601+
<td>ULINK2/ULINKplus support</td>
602602
</tr>
603603
<tr>
604604
<td>&#128993; Debug probes</td>
605-
<td>UILNKpro support</td>
605+
<td>ULINKpro support</td>
606606
</tr>
607607
<tr>
608608
<td>&#128994; <a href="debug.html#debug-adapter-support">Debug probes</a></td>
9.89 KB
Loading

site/images/arm-tools-zero.png

1.65 KB
Loading
File renamed without changes.

site/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,5 +272,5 @@ <h2 id="revision-history">Revision history</h2>
272272

273273
<!--
274274
MkDocs version : 1.6.1
275-
Build Date UTC : 2026-02-27 11:11:19.285038+00:00
275+
Build Date UTC : 2026-03-03 12:41:08.944688+00:00
276276
-->

0 commit comments

Comments
 (0)