You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/install-guides/container.md
+18-14Lines changed: 18 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Container CLI is an open-source command-line tool from Apple for building and ru
18
18
19
19
The CLI supports the full Open Container Initiative (OCI) workflow: building, running, tagging, and pushing container images.
20
20
21
-
In this guide, you'll learn how to install and use the Container CLI to run Arm Linux containers natively on Apple silicon Macs.
21
+
In this guide, you'll learn how to install and verify the Container CLI to run Arm Linux containers natively on Apple silicon Macs.
22
22
23
23
## Before you begin
24
24
@@ -28,11 +28,12 @@ First, confirm you are using an Apple silicon Mac by running:
28
28
uname -m
29
29
```
30
30
31
-
The output should be:
31
+
The expected output is:
32
32
33
33
```output
34
34
arm64
35
35
```
36
+
36
37
{{% notice Note %}}
37
38
Container CLI supports only Apple silicon Macs (M1, M2, M3, and M4).
38
39
{{% /notice %}}
@@ -43,28 +44,30 @@ Check your macOS version:
43
44
sw_vers -productVersion
44
45
```
45
46
46
-
Example output:
47
+
The output is similar to:
47
48
48
49
```output
49
-
15.6.1
50
+
26.5.1
50
51
```
51
52
52
53
You must run macOS 15.0 or later to use the Container CLI.
53
54
54
55
## Install Container CLI
55
56
56
-
To install Container CLI, go to the [GitHub Releases page](https://github.com/apple/container/releases) and download the latest signed `.pkg` installer.
57
+
To install Container CLI, go to the [GitHub Releases page](https://github.com/apple/container/releases) and download the latest signed `.pkg` installer.
57
58
58
-
For example, the following commands use version `0.11.0`. Replace `0.11.0` with the latest version:
59
+
{{% notice Note %}}
60
+
The following commands use Container CLI version 1.0.0. The same commands work with other versions. Replace the file used in these steps with the file for your version of choice. To find the latest version, see [GitHub Releases](https://github.com/apple/container/releases).
weight: 1# Defines page ordering. Must be 1 for first (or only) page.
29
-
tool_install: true # Set to true to be listed in main selection page, else false
30
-
multi_install: false # Set to true if first page of multi-page article, else false
31
-
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
32
-
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
21
+
weight: 1
22
+
tool_install: true
23
+
multi_install: false
24
+
multitool_install_part: false
25
+
layout: installtoolsall
33
26
---
34
27
[Arm Keil Studio](https://keil.arm.com/) is the next generation software development environment for Arm Cortex-M based microcontroller devices. The desktop version is available as a set of [Visual Studio Code](https://code.visualstudio.com/) extensions.
35
28
36
29
Alternatively, [Keil Studio Cloud](/install-guides/keilstudiocloud/) provides similar functionality, but runs in a browser and requires no installation.
37
30
38
-
## Where can I download Visual Studio Code?
31
+
## Download and install Visual Studio Code
39
32
40
-
[Download](https://code.visualstudio.com/download), install, and start `Visual Studio Code` on your desktop.
33
+
[Download](https://code.visualstudio.com/download), install, and start Visual Studio Code on your desktop.
41
34
42
35
Linux, macOS, and Windows are supported.
43
36
44
-
## How do I install the Keil Studio extensions?
37
+
## Install the Keil Studio extensions
45
38
46
-
The `Keil Studio Pack` extensions is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack).
39
+
The **Keil Studio Pack** extension is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack).
47
40
48
41
Install the Keil Studio extensions:
49
42
50
-
1. Open the `Extensions` view in Visual Studio Code
51
-
2. Search for `Keil Studio Pack`
52
-
3.Click the `Install` button to install all extensions in the `Keil Studio Pack`
43
+
1. Open the **Extensions** view in Visual Studio Code
44
+
2. Search for **Keil Studio Pack**
45
+
3.Select the **Install** button to install all extensions in the **Keil Studio Pack**
53
46
54
-
Visual Studio Code installs the extensions. The extensions are now available in the `Activity Bar`.
47
+

55
48
56
-
You will be prompted to enable an [MDK Community License](https://www.keil.arm.com/mdk-community/) for non-commercial use. Accept this option if you do not have a license and agree to non-commercial use.
49
+
## Verify the installation
57
50
58
-
If you have a commercial license for `Keil MDK` installed, decline this option.
51
+
After installation, the Keil Studio icons appear in the **Activity Bar** on the left side of VS Code.
59
52
60
-
## How do I get started?
53
+

61
54
62
-
Follow the [Getting started with an example project](https://developer.arm.com/documentation/108029/latest/Get-started-with-an-example-project) tutorial to verify the extensions are installed correctly.
55
+
To verify the extensions are working correctly, follow the [Work with CMSIS solutions](https://mdk-packs.github.io/vscode-cmsis-solution-docs/create_app.html#) tutorial.
63
56
64
-
## Where can I find more information about the Keil Studio extensions?
57
+
## More information
65
58
66
59
Use the table below to find additional information about the VS Code extensions.
67
60
68
61
| Extension | Description |
69
62
|-----------|-------------|
70
-
|[Arm CMSIS csolution](https://github.com/ARM-software/vscode-cmsis-csolution/blob/main/README.md)|provides support for working with CMSIS solutions (csolution projects).|
71
-
|[Arm Device Manager](https://github.com/ARM-software/vscode-device-manager/blob/main/README.md)|allows you to manage device connections for Arm Cortex-M based microcontrollers, development boards and debug probes.|
72
-
|[Arm Embedded Debugger](https://github.com/ARM-software/vscode-embedded-debug/blob/main/README.md)|allows you to do flashing and debugging on Arm Cortex-M targets implementing the Microsoft Debug Adapter Protocol (DAP). |
73
-
|[Arm Remote Build](https://github.com/ARM-software/vscode-remote-build/blob/main/README.md)|allows you to undertake remote builds of projects for Arm Cortex-M targets. |
74
-
|[Arm Virtual Hardware](https://github.com/ARM-software/vscode-virtual-hardware/blob/main/README.md)|allows you to manage Arm Virtual Hardware and run embedded applications on them. |
75
-
|[Keil Studio Pack](https://github.com/ARM-software/vscode-keil-studio-pack/blob/main/README.md)| installs recommended extensions for embedded and IoT software development on Arm-based microcontroller (MCU) devices. |
63
+
|[Arm CMSIS csolution](https://github.com/ARM-software/vscode-cmsis-csolution/blob/main/README.md)|Provides support for working with CMSIS solutions (csolution projects).|
64
+
|[Arm Device Manager](https://github.com/ARM-software/vscode-device-manager/blob/main/README.md)|Allows you to manage device connections for Arm Cortex-M based microcontrollers, development boards and debug probes.|
65
+
|[Arm Embedded Debugger](https://github.com/ARM-software/vscode-embedded-debug/blob/main/README.md)|Allows you to do flashing and debugging on Arm Cortex-M targets implementing the Microsoft Debug Adapter Protocol (DAP). |
66
+
|[Arm Remote Build](https://github.com/ARM-software/vscode-remote-build/blob/main/README.md)|Allows you to undertake remote builds of projects for Arm Cortex-M targets. |
67
+
|[Arm Virtual Hardware](https://github.com/ARM-software/vscode-virtual-hardware/blob/main/README.md)|Allows you to manage Arm Virtual Hardware and run embedded applications on them. |
68
+
|[Keil Studio Pack](https://github.com/ARM-software/vscode-keil-studio-pack/blob/main/README.md)|Installs recommended extensions for embedded and IoT software development on Arm-based microcontroller (MCU) devices. |
Copy file name to clipboardExpand all lines: content/learning-paths/automotive/zenacssdebug/launch.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ You can launch the FVP within the build environment with the software stack load
16
16
kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose"
17
17
```
18
18
19
-
See the [Arm Zena CSS User Guide](https://arm-auto-solutions.docs.arm.com/en/v2.0/rd-aspen/user_guide/reproduce.html#run-the-fvp) for further information.
19
+
See the [Arm Zena CSS User Guide](https://arm-zena-css.docs.arm.com/en/latest/user_guide/reproduce.html#run-the-fvp) for further information.
20
20
21
21
While you can continue to use this method during debugging, it does not enable the Iris debug server in the model, so the system cannot be debugged from Arm Development Studio. Additional command-line options are required.
Copy file name to clipboardExpand all lines: content/learning-paths/automotive/zenacssdebug/zena.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ For more information, see [Arm Zena Compute Subsystem (CSS)](https://developer.a
20
20
21
21
## Build the software stack
22
22
23
-
Follow the steps to download and build the software stack in the [Arm Automotive Solutions Software Reference Stack User Guide](https://arm-auto-solutions.docs.arm.com/en/latest/rd-aspen/user_guide/reproduce.html).
23
+
Follow the steps to download and build the software stack in the [Arm Automotive Solutions Software Reference Stack User Guide](https://arm-zena-css.docs.arm.com/en/latest/user_guide/reproduce.html).
24
24
25
25
The default **Cfg1, Arm Automotive Solutions Demo, Bare Metal** build is used in this learning path.
26
26
@@ -29,7 +29,9 @@ Software build will usually take at least one hour to complete, depending on hos
29
29
{{% notice Note %}}
30
30
The primary focus of this Learning Path is to demonstrate how to debug the software stack.
31
31
32
-
The latest version of software tested at time of writing is `2.1`. Screenshots show previous versions.
32
+
The latest version of software tested at time of writing is `2.2`. Screenshots show previous versions.
33
+
34
+
For documentation of earlier versions, go to [here](https://arm-auto-solutions.docs.arm.com).
Copy file name to clipboardExpand all lines: content/learning-paths/cross-platform/create-your-own-topo-templates/_index.md
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,23 @@
1
1
---
2
-
title: Create your own Topo Templates
3
-
4
-
draft: true
5
-
cascade:
6
-
draft: true
2
+
title: Create and deploy a custom Topo Template
7
3
8
-
description: Create a Topo Template after your project to use Topo to deploy containerized workloads to Arm-based Linux targets over SSH.
4
+
description: Understand how to create and modify Topo Templates, allowing you to deploy your projects as containerized workloads to Arm-based Linux targets over SSH.
9
5
10
6
minutes_to_complete: 30
11
7
12
8
who_is_this_for: This is an introductory topic for embedded, edge, and cloud software developers who want to create their own Topo Templates projects to be natively deployed with Topo.
13
9
14
10
learning_objectives:
15
11
- Explain the purpose and structure of a Topo Template
16
-
- Clone and deploy an existing Topo Template to validate the Template workflow
17
-
- Add clone-time arguments to customize a Topo Template
12
+
- Clone and deploy an existing Topo Template and modify it by adding new clone-time arguments
18
13
- Create a new Topo Template from a Docker Compose project
19
14
- Add x-topo metadata for configurable arguments, deployment guidance, and hardware requirements
15
+
- Locate and install Agent Skills to assist with creating and reviewing Topo Templates
20
16
21
17
prerequisites:
22
-
- This learning path builds on [Deploy containerized workloads to Arm-based Linux targets with Topo](/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/).
18
+
- Completion of the [Deploy containerized workloads to Arm-based Linux targets with Topo](/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/) Learning Path.
23
19
- A host machine (x86 or Arm) with Linux, macOS, or Windows
24
-
- (Optional) An Arm-based Linux target accessible over SSH, for example an Arm-based Linux VM, Raspberry Pi, DGX Spark, or NXP i.MX 93
20
+
- An Arm-based Linux target accessible over SSH, for example an Arm-based Linux VM, Raspberry Pi, DGX Spark, or NXP i.MX 93
25
21
- Docker installed on the host and target. For installation steps, see [Install Docker](/install-guides/docker/).
description: Install and use Topo Template Agent Skills to help create, review, and refine Topo Templates.
4
+
weight: 6
5
+
6
+
### FIXED, DO NOT MODIFY
7
+
layout: learningpathall
8
+
---
9
+
10
+
## Skills for authoring Topo Templates
11
+
12
+
If you already have a Docker Compose project and want to convert it to a Topo Template, you can do so with an Agent Skill. You can also use a skill to create your own Topo Template from scratch. These skills are optional authoring aids.
13
+
14
+
The [Topo Template Format Specification](https://github.com/arm/topo-template-format) currently provides the following skills:
15
+
16
+
-`topo-template-context`: provides Topo and Topo Template reference context for questions about x-topo metadata, schema, docs, and CLI template behavior.
17
+
-`topo-template-bootstrap`: converts a repository into a Topo Template by adding or improving `compose.yaml` and `x-topo` metadata.
18
+
-`topo-template-lint`: reviews an existing Topo Template for correctness, consistency, and authoring best practices.
19
+
20
+
For the most up-to-date list of the available Topo Template skills, see [Topo Skills](https://github.com/arm/topo-template-format#authoring-skills) .
21
+
22
+
## Install the skills
23
+
24
+
Install the Topo Template skills with [npx skills](https://github.com/vercel-labs/skills):
25
+
26
+
{{% notice Note %}}
27
+
`npx` requires Node.js. If you don't have Node.js installed on your machine, install it before running the following command.
Restart your AI coding agent after installing or updating skills to make sure new skills are loaded for use.
35
+
36
+
## Use the skills
37
+
38
+
After installing skills, you can prompt your agent to use a skill.
39
+
40
+
For example, to create a Topo Template from an existing project:
41
+
42
+
```text
43
+
Use the topo-template-bootstrap skill to convert this repository into a Topo Template.
44
+
```
45
+
46
+
## What you've accomplished
47
+
48
+
You've now learned how you can install and use Agent Skills to help author Topo Templates.
49
+
50
+
You can now create, modify, and deploy Topo Templates to Arm-based Linux targets. To find more templates to clone and modify, explore the [Topo Catalog](https://github.com/arm/topo/blob/main/internal/catalog/data/catalog.json).
0 commit comments