Skip to content

Commit 986497b

Browse files
Merge pull request #3397 from ArmDeveloperEcosystem/main
production update
2 parents b98ab25 + ffccac2 commit 986497b

71 files changed

Lines changed: 2251 additions & 405 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.wordlist.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6305,3 +6305,12 @@ unbuffered
63056305
upserting
63066306
userinfo
63076307
voicechatbot
6308+
ChromaDB
6309+
Sonoma
6310+
cnNm
6311+
llamaindex
6312+
microVM
6313+
microVMs
6314+
microvm
6315+
npx
6316+
sbx
6.93 KB
Loading
26.8 KB
Loading

content/install-guides/container.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Container CLI is an open-source command-line tool from Apple for building and ru
1818

1919
The CLI supports the full Open Container Initiative (OCI) workflow: building, running, tagging, and pushing container images.
2020

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.
2222

2323
## Before you begin
2424

@@ -28,11 +28,12 @@ First, confirm you are using an Apple silicon Mac by running:
2828
uname -m
2929
```
3030

31-
The output should be:
31+
The expected output is:
3232

3333
```output
3434
arm64
3535
```
36+
3637
{{% notice Note %}}
3738
Container CLI supports only Apple silicon Macs (M1, M2, M3, and M4).
3839
{{% /notice %}}
@@ -43,28 +44,30 @@ Check your macOS version:
4344
sw_vers -productVersion
4445
```
4546

46-
Example output:
47+
The output is similar to:
4748

4849
```output
49-
15.6.1
50+
26.5.1
5051
```
5152

5253
You must run macOS 15.0 or later to use the Container CLI.
5354

5455
## Install Container CLI
5556

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.
5758

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).
61+
{{% /notice %}}
5962

6063
```bash
61-
wget https://github.com/apple/container/releases/download/0.11.0/container-0.11.0-installer-signed.pkg
64+
wget https://github.com/apple/container/releases/download/1.0.0/container-1.0.0-installer-signed.pkg
6265
```
6366

6467
Install the package:
6568

6669
```bash
67-
sudo installer -pkg container-0.11.0-installer-signed.pkg -target /
70+
sudo installer -pkg container-1.0.0-installer-signed.pkg -target /
6871
```
6972

7073
This installs the Container binary at `/usr/local/bin/container`.
@@ -88,7 +91,7 @@ container --version
8891
The output is similar to:
8992

9093
```output
91-
container CLI version 0.11.0 (build: release, commit: d9b8a8d)
94+
container CLI version 1.0.0 (build: release, commit: ee848e3)
9295
```
9396

9497
## Verify installation by building and running a container
@@ -111,10 +114,11 @@ Run the following to build and tag the container image as `uname`:
111114
container build -t uname .
112115
```
113116

114-
Example output:
117+
The output is similar to:
115118

116119
```output
117-
Successfully built uname:latest
120+
[+] Building 2.7s (5/5) FINISHED
121+
uname:latest
118122
```
119123

120124
### Run the container
@@ -125,7 +129,7 @@ Run the container to verify it prints the system architecture.
125129
container run --rm uname
126130
```
127131

128-
Expected output:
132+
The expected output is:
129133

130134
```output
131135
Architecture is aarch64
@@ -181,7 +185,7 @@ container ls
181185

182186
The CLI includes an uninstall script. You can choose whether to keep or delete your container data.
183187

184-
To uninstall and retain user data (images and containers):
188+
To uninstall and retain user data (images and containers):
185189

186190
```bash
187191
uninstall-container.sh -k
@@ -194,6 +198,6 @@ Otherwise, to uninstall and delete all user data:
194198
uninstall-container.sh -d
195199
```
196200

197-
This will remove the CLI and all related images, logs, and metadata.
201+
This removes the CLI and all related images, logs, and metadata.
198202

199203
You’ve now ready to use Container CLI.

content/install-guides/gcc/arm-gnu.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ There are many versions of the [Arm GNU Toolchain](https://developer.arm.com/Too
2626

2727
However there are reasons you may wish to use earlier compiler versions, so older versions are also available.
2828

29+
See also [Where can I get older versions of the Arm GNU Toolchain and GCC for Arm Platforms?](https://developer.arm.com/documentation/ka005611/latest)
30+
2931
## Download the Arm GNU Toolchain {#download}
3032

3133
Arm GNU Toolchain releases consist of cross toolchains for the following host operating systems:
@@ -171,4 +173,4 @@ Additional examples are included in the toolchain installation. If you installed
171173
```console
172174
$HOME/arm-gnu-toolchain-15.2.rel1-aarch64-arm-none-eabi/share/doc/gcc-arm-none-eabi/examples
173175
```
174-
You're now ready to use Arm GNU Toolchain.
176+
You're now ready to use Arm GNU Toolchain.
Lines changed: 24 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
2-
### Title the install tools article with the name of the tool to be installed
3-
### Include vendor name where appropriate
42
title: Arm Keil Studio for VS Code
53

6-
### Optional additional search terms (one per line) to assist in finding the article
74
additional_search_terms:
85
- cortex-m
96
- microcontroller
@@ -15,61 +12,57 @@ additional_search_terms:
1512
- visual studio
1613
- cmsis
1714

18-
19-
### Estimated completion time in minutes (please use integer multiple of 5)
2015
minutes_to_complete: 15
2116

2217
author: Ronan Synnott
2318

24-
### Link to official documentation
2519
official_docs: https://developer.arm.com/documentation/108029
2620

27-
### PAGE SETUP
28-
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
3326
---
3427
[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.
3528

3629
Alternatively, [Keil Studio Cloud](/install-guides/keilstudiocloud/) provides similar functionality, but runs in a browser and requires no installation.
3730

38-
## Where can I download Visual Studio Code?
31+
## Download and install Visual Studio Code
3932

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.
4134

4235
Linux, macOS, and Windows are supported.
4336

44-
## How do I install the Keil Studio extensions?
37+
## Install the Keil Studio extensions
4538

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).
4740

4841
Install the Keil Studio extensions:
4942

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**
5346

54-
Visual Studio Code installs the extensions. The extensions are now available in the `Activity Bar`.
47+
![The Keil Studio Pack extension shown in the VS Code Extensions marketplace view, with the Arm publisher name and Install button visible#center](/install-guides/_images/ks-extension.webp "Keil Studio Pack in the VS Code Extensions marketplace")
5548

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
5750

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.
5952

60-
## How do I get started?
53+
![VS Code Activity Bar showing the Keil Studio extension icons after successful installation of the Keil Studio Pack#center](/install-guides/_images/ks-installed.webp "Keil Studio extensions visible in the VS Code Activity Bar")
6154

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.
6356

64-
## Where can I find more information about the Keil Studio extensions?
57+
## More information
6558

6659
Use the table below to find additional information about the VS Code extensions.
6760

6861
| Extension | Description |
6962
|-----------|-------------|
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. |

content/learning-paths/automotive/zenacssdebug/launch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can launch the FVP within the build environment with the software stack load
1616
kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose"
1717
```
1818

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.
2020

2121
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.
2222

content/learning-paths/automotive/zenacssdebug/zena.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For more information, see [Arm Zena Compute Subsystem (CSS)](https://developer.a
2020

2121
## Build the software stack
2222

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).
2424

2525
The default **Cfg1, Arm Automotive Solutions Demo, Bare Metal** build is used in this learning path.
2626

@@ -29,7 +29,9 @@ Software build will usually take at least one hour to complete, depending on hos
2929
{{% notice Note %}}
3030
The primary focus of this Learning Path is to demonstrate how to debug the software stack.
3131

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).
3335
{{% /notice %}}
3436

3537
## Verify the build and execution

content/learning-paths/cross-platform/create-your-own-topo-templates/_index.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,23 @@
11
---
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
73

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.
95

106
minutes_to_complete: 30
117

128
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.
139

1410
learning_objectives:
1511
- 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
1813
- Create a new Topo Template from a Docker Compose project
1914
- 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
2016

2117
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.
2319
- 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
2521
- Docker installed on the host and target. For installation steps, see [Install Docker](/install-guides/docker/).
2622
- Basic familiarity with containers and CLI tools
2723

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Use Agent Skills to author Topo Templates
3+
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.
28+
{{% /notice %}}
29+
30+
```bash
31+
npx skills add arm/topo-template-format --all --yes
32+
```
33+
34+
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

Comments
 (0)