Skip to content

Commit 332d396

Browse files
Reducing ambuiguity
1 parent b575f5f commit 332d396

File tree

1 file changed

+16
-12
lines changed
  • content/learning-paths/cross-platform/multiplying-matrices-with-sme2

1 file changed

+16
-12
lines changed

content/learning-paths/cross-platform/multiplying-matrices-with-sme2/1-get-started.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This section walks you through the required tools and the two supported executio
2020

2121
To get started, begin by [downloading the code examples](https://gitlab.arm.com/learning-cde-examples/code-examples/-/archive/main/code-examples-main.tar.gz?path=learning-paths/cross-platform/multiplying-matrices-with-sme2).
2222

23-
Now extract the archive, and change to the target directory:
23+
Now extract the archive, and change directory to:
2424
``code-examples/learning-paths/cross-platform/multiplying-matrices-with-sme2.``
2525

2626
```BASH
@@ -59,16 +59,16 @@ code-examples/learning-paths/cross-platform/multiplying-matrices-with-sme2/
5959
└── sme2_check.c
6060
```
6161

62-
It includes:
62+
Amongst other files, it includes:
6363
- Code examples.
6464
- A `Makefile` to build the code.
6565
- `run-fvp.sh` to run the FVP model.
6666
- A `docker` directory containing:
6767
- `assets.source_me` to provide toolchain paths.
68-
- `build-my-container.sh`, a script that automates building the Docker image from the `sme2-environment.docker` file. It runs the docker build command with the correct arguments so you don’t have to remember them.
68+
- `build-my-container.sh`, a script that automates building the Docker image from the `sme2-environment.docker` file. It runs the Docker build command with the correct arguments so you don’t have to remember them.
6969
- `sme2-environment.docker`, a Docker file that defines the steps to build the SME2 container image. It installs all the necessary dependencies, including the SME2-compatible compiler and Arm FVP emulator.
7070
- `build-all-containers.sh`, a script to build multi-architecture images.
71-
- `.devcontainer/devcontainer.json` for VS Code container support.
71+
- `.devcontainer/devcontainer.json` for VS Code container support.
7272

7373
{{% notice Note %}}
7474
From this point, all instructions assume that your current directory is
@@ -108,24 +108,26 @@ You are now all set to start hacking with SME2.
108108

109109
If your machine doesn't support SME2, or you want to emulate it, you can use the Docker-based environment that this Learning Path models.
110110

111-
The Docker container includes a compiler and [Arm's Fixed Virtual Platform (FVP)
111+
The Docker container includes both a compiler and [Arm's Fixed Virtual Platform (FVP)
112112
model](https://developer.arm.com/Tools%20and%20Software/Fixed%20Virtual%20Platforms)
113-
for emulating code with SME2 instructions. You can run the provided image or build it using the included Dockerfile.and follow the ``sme2-environment.docker`` Docker file instructions to install the tools on your machine.
113+
for emulating code that uses SME2 instructions. You can either run the prebuilt container image provided in this Learning Path or build it yourself using the Docker file that is included.
114+
115+
If building manually, follow the instructions in the ``sme2-environment.docker`` file to install the required tools on your machine.
114116

115117
### Install and verify Docker
116118

117119
{{% notice Note %}}
118120
Docker is optional, but if you don’t use it, you must manually install the compiler and FVP, and ensure they’re in your `PATH`.
119121
{{% /notice %}}
120122

121-
To begin, start by checking that ``docker`` is installed on your machine:
123+
To begin, start by checking that Docker is installed on your machine:
122124

123125
```BASH { output_lines="2" }
124126
docker --version
125127
Docker version 27.3.1, build ce12230
126128
```
127129

128-
If the above command fails with a message similar to "``docker: command not found``", then follow the steps from the [Docker Install Guide](https://learn.arm.com/install-guides/docker/) to install it.
130+
If the above command fails with an error message similar to "``docker: command not found``", then follow the steps from the [Docker Install Guide](https://learn.arm.com/install-guides/docker/) to install Docker.
129131

130132
{{% notice Note %}}
131133
You might need to log out and back in again or restart your machine for the changes to take
@@ -176,9 +178,9 @@ https://docs.docker.com/get-started/
176178
```
177179

178180
You can use Docker in the following ways:
179-
- [Directly from the command line](#run-commands-from-a-terminal-using-docker). For example, when you are working from a terminal on your local machine.
181+
- [Directly from the command line](#run-commands-from-a-terminal-using-docker) - for example, when you are working from a terminal on your local machine.
180182

181-
- [Within a containerized environment](#use-an-interactive-docker-shell). Configure VS Code to execute all the commands inside a Docker container, allowing you to work seamlessly within the
183+
- [Within a containerized environment](#use-an-interactive-docker-shell) - by configuring VS Code to execute all the commands inside a Docker container, allowing you to work seamlessly within the
182184
Docker environment.
183185

184186
### Run commands from a terminal using Docker
@@ -209,13 +211,15 @@ docker run --rm -v "$PWD:/work" -w /work armswdev/sme2-learning-path:sme2-enviro
209211

210212
### Use an interactive Docker shell
211213

212-
The above commands are long and error-prone, so you can instead choose to work interactively within the terminal, which would save you from prepending the ``docker run ...`` magic before each command you want to execute. To work in this mode, run Docker without any command (note the ``-it`` command line argument to the Docker invocation). Start an interactive session to avoid repeating the docker run prefix:
214+
The standard `docker run` commands can be long and repetitive. To streamline your workflow, you can start an interactive Docker session that allows you to run commands directly - without having to prepend docker run each time.
215+
216+
To launch an interactive shell inside the container, use the `-it` flag:
213217

214218
```BASH
215219
docker run --rm -it -v "$PWD:/work" -w /work armswdev/sme2-learning-path:sme2-environment-v2
216220
```
217221

218-
You are now in the Docker container; you can execute all commands directly. For
222+
You are now in the Docker container, and you can execute all commands directly. For
219223
example, the ``make`` command can now be simply invoked with:
220224

221225
```BASH

0 commit comments

Comments
 (0)