Skip to content

Commit 6d394c9

Browse files
Merge pull request #1887 from jasonrandrews/review2
Change install guide headings to questions
2 parents 72c7591 + d4fbfa1 commit 6d394c9

Some content is hidden

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

55 files changed

+281
-278
lines changed

content/install-guides/acfl.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Arm Compiler for Linux runs on 64-bit Arm machines, it is not a cross-compiler.
2626

2727
You do not require any additional license to use Arm Compiler for Linux.
2828

29-
## Arm-based hardware
29+
## What Arm-based hardware is supported by Arm Compiler for Linux (ACfL)?
3030

3131
Arm Compiler for Linux supports all 64-bit Arm based [server-class hardware](/learning-paths/servers-and-cloud-computing/intro/).
3232

@@ -46,7 +46,7 @@ aarch64
4646

4747
If you see a different result, you are not using an Arm computer running 64-bit Linux.
4848

49-
## Install pre-requisites
49+
## What pre-requisites do I need to install for ACfL?
5050

5151
If any of the following tools are not already installed by your Linux
5252
distribution, you must install them before installing Arm Compiler for Linux.
@@ -72,25 +72,25 @@ sudo apt install -y python-is-python3 libc6-dev
7272

7373
You are now ready to install ACfL [manually](#manual) or with [Spack](#spack).
7474

75-
## Download and install using install script
75+
## How do I download and install ACfL using the install script?
7676

7777
Use an Arm recommended script to select, download, and install your preferred ACfL package.
7878

7979
```console
8080
bash <(curl -L https://developer.arm.com/-/cdn-downloads/permalink/Arm-Compiler-for-Linux/Package/install.sh)
8181
```
8282

83-
## Download and install manually {#manual}
83+
## How do I download and install ACfL manually? {#manual}
8484

85-
### Download with wget
85+
### How do I download ACfL with wget?
8686

8787
Download releases from the command line using `wget`. Install `wget` if not present.
8888

8989
```bash
9090
sudo apt install wget
9191
```
9292

93-
### Fetch the appropriate installer
93+
### How do I fetch the appropriate ACfL installer?
9494

9595
ACfL installation packages are available to download from [Arm Developer](https://developer.arm.com/downloads/-/arm-compiler-for-linux). Individual Arm Performance Libraries (ArmPL) packages are also available.
9696

@@ -106,7 +106,7 @@ wget https://developer.arm.com/-/cdn-downloads/permalink/Arm-Compiler-for-Linux
106106
wget https://developer.arm.com/-/cdn-downloads/permalink/Arm-Compiler-for-Linux/Version_24.10.1/arm-compiler-for-linux_24.10.1_RHEL-9_aarch64.tar
107107
```
108108

109-
### Install
109+
### How do I install ACfL?
110110

111111
To install Arm Compiler for Linux on your 64-bit Linux Arm machine extract the package and run the installation script.
112112

@@ -139,13 +139,13 @@ install takes place **after** ACfL, you will no longer be able to fully
139139
uninstall ACfL.
140140
{{% /notice %}}
141141

142-
## Download and install using System Packages
142+
## How do I download and install ACfL using System Packages?
143143

144-
### Ubuntu Linux 20.04 and 22.04
144+
### How do I install ACfL on Ubuntu Linux 20.04 and 22.04?
145145

146146
Arm Compiler for Linux is available to install with the Ubuntu system package manager `apt` command.
147147

148-
#### Set up the ACfL package repository
148+
#### How do I set up the ACfL package repository?
149149

150150
Add the ACfL `apt` package repository to your system. These instructions apply for Ubuntu 22.04. You can check the [available versions](https://developer.arm.com/packages/) for other releases.
151151

@@ -166,11 +166,11 @@ Install Arm Compiler for Linux with:
166166
sudo apt install acfl -y
167167
```
168168

169-
### Amazon Linux 2023
169+
### How do I install ACfL on Amazon Linux 2023?
170170

171171
Arm Compiler for Linux is available to install with either the `dnf` or `yum` system package manager.
172172

173-
#### Install ACfL from the Amazon Linux 2023 package repository
173+
#### How do I install ACfL from the Amazon Linux 2023 package repository?
174174

175175
Install ACfL and prerequisites from the Amazon Linux 2023 `rpm` package repository with `dnf`:
176176

@@ -192,11 +192,11 @@ sudo yum -y install acfl
192192

193193
The ACfL tools are now ready to use.
194194

195-
### Red Hat Enterprise Linux (RHEL) 9
195+
### How do I install ACfL on Red Hat Enterprise Linux (RHEL) 9?
196196

197197
Arm Compiler for Linux is available to install with either the `dnf` or `yum` system package manager.
198198

199-
#### Install ACfL from the RHEL 9 package repository
199+
#### How do I install ACfL from the RHEL 9 package repository?
200200

201201
Install ACfL and prerequisites from the RHEL 9 `rpm` package repository with `dnf`:
202202

@@ -218,7 +218,7 @@ sudo yum -y install acfl
218218

219219
The ACfL tools are now ready to use.
220220

221-
### Set up environment
221+
### How do I set up the environment for ACfL?
222222

223223
Arm Compiler for Linux uses environment modules to dynamically modify your user environment. Refer to the [Environment Modules documentation](https://lmod.readthedocs.io/en/latest/#id) for more information.
224224

@@ -256,13 +256,13 @@ module load gnu/14.2.0
256256

257257
ACfL is now [ready to use](#armclang).
258258

259-
## Download and install with Spack {#spack}
259+
## How do I download and install ACfL with Spack? {#spack}
260260

261261
Arm Compiler for Linux is available with the [Spack](https://spack.io/) package manager.
262262

263263
See the [Arm Compiler for Linux and Arm PL now available in Spack](https://community.arm.com/arm-community-blogs/b/high-performance-computing-blog/posts/arm-compiler-for-linux-and-arm-pl-now-available-in-spack) blog for full details.
264264

265-
### Set up Spack
265+
### How do I set up Spack for ACfL?
266266

267267
Clone the Spack repository and add `bin` directory to the path:
268268

@@ -279,7 +279,7 @@ Set up shell support:
279279

280280
Spack is now ready to use.
281281

282-
### Install ACfL
282+
### How do I install ACfL using Spack?
283283

284284
Download and install Arm Compiler for Linux with:
285285

@@ -293,7 +293,7 @@ If you wish to install just the Arm Performance Libraries, use:
293293
spack install armpl-gcc
294294
```
295295

296-
### Set up environment
296+
### How do I set up the environment for ACfL using Spack?
297297
Use the commands below to set up the environment:
298298

299299
```console
@@ -304,7 +304,7 @@ spack compiler find
304304
ACfL is now [ready to use](#armclang).
305305

306306

307-
## Get started with Arm C/C++ compiler {#armclang}
307+
## How do I get started with the Arm C/C++ compiler? {#armclang}
308308

309309
To get started with the Arm C/C++ Compiler and compile a simple application follow the steps below.
310310

@@ -342,7 +342,7 @@ The program will output the string specified.
342342
Hello, C World!
343343
```
344344

345-
## Get started with Arm Fortran compiler {#fortran}
345+
## How do I get started with the Arm Fortran compiler? {#fortran}
346346

347347
To get started with the Arm Fortran Compiler and compile a simple application follow the steps below.
348348

@@ -375,6 +375,6 @@ The program will output the string specified.
375375
Hello, Fortran World!
376376
```
377377

378-
## Get started with Arm Performance Libraries {#armpl}
378+
## How do I get started with Arm Performance Libraries? {#armpl}
379379

380380
To get started with the [Arm Performance Libraries](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Libraries) and learn how to select the optimal library for your system, follow the [Get started with Arm Performance Libraries](https://developer.arm.com/documentation/101004/latest) guide.

content/install-guides/ambaviz.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ test_images:
3737

3838
A detailed overview of functionality is described in [Introduction to AMBA Viz](https://community.arm.com/arm-community-blogs/b/soc-design-and-simulation-blog/posts/introduction-to-amba-viz).
3939

40-
## Download installer packages
40+
## How do I download AMBA Viz?
4141

4242
AMBA Viz is a component of [Arm Hardware Success Kits](https://www.arm.com/products/development-tools/success-kits).
4343

@@ -47,7 +47,7 @@ You can download AMBA Viz as an individual component, or you can download comple
4747

4848
For more information on the Download Hub, refer to the [Arm Product Download Hub install guide](/install-guides/pdh/).
4949

50-
## Installation
50+
## How do I install AMBA Viz?
5151

5252
AMBA Viz requires a Linux host machine with Java 11 or JavaFX.
5353

@@ -73,13 +73,13 @@ The AMBA Viz Release Notes provide full installation instructions, located in th
7373
docs/public/assets/pdfs/ambaviz-release-note.pdf
7474
```
7575

76-
## Set up the product license
76+
## How do I set up the AMBA Viz product license?
7777

7878
AMBA Viz is license-managed. A Hardware Success Kit license is necessary.
7979

8080
License set up instructions are available in the [Arm License install guide](/install-guides/license/).
8181

82-
## Get started
82+
## How do I get started with AMBA Viz?
8383

8484
Typically, AMBA Viz is launched with a waveform file:
8585
```console

content/install-guides/ams.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,26 +47,26 @@ It comprises of a suite of easy-to-use tools that show you how well your game or
4747

4848
All features of Arm Performance Studio are available free of charge without any additional license as of the `2022.4` release.
4949

50-
## Installation
50+
## How do I install Arm Performance Studio?
5151

5252
Arm Performance Studio is supported on Windows, Linux, and macOS hosts. Download the appropriate installer from [Arm Performance Studio Downloads](https://developer.arm.com/Tools%20and%20Software/Arm%20Performance%20Studio#Downloads).
5353

5454
Full installation and application launch instructions are given in the Arm Performance Studio [Release Notes](https://developer.arm.com/documentation/107649).
5555

56-
### Windows
56+
### How do I install Arm Performance Studio on Windows?
5757

5858
Run the supplied `Arm_Performance_Studio_<version>_windows_x86-64.exe` installer, and follow on-screen instructions.
5959

60-
### Linux
60+
### How do I install Arm Performance Studio on Linux?
6161

6262
Unpack the supplied `Arm Performance Studio` bundle to the desired location. For example:
6363
```console
6464
tar -xf Arm_Performance_Studio_2024.3_linux_x86-64.tgz
6565
```
66-
### macOS
66+
### How do I install Arm Performance Studio on macOS?
6767

6868
Run the supplied `Arm_Performance_Studio_<version>_macos_x86-64.dmg` installer, and follow on-screen instructions.
6969

70-
## Get started
70+
## How do I get started with Arm Performance Studio?
7171

7272
See the [Get started with Arm Performance Studio for Mobile](/learning-paths/mobile-graphics-and-gaming/ams/) learning path for a collection of tutorials for each component of Performance Studio.

content/install-guides/anaconda.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ eval "$($HOME/anaconda3/bin/conda shell.bash hook)"
9595

9696
Test Anaconda Distribution by running simple TensorFlow and PyTorch examples.
9797

98-
### TensorFlow
98+
### How do I use TensorFlow with Anaconda?
9999

100100
Create a new conda environment named tf, install TensorFlow, and activate the new environment.
101101

@@ -139,7 +139,7 @@ The expected output format is below. Your version may be slightly different.
139139
tf.Tensor(342.34387, shape=(), dtype=float32)
140140
```
141141

142-
### PyTorch
142+
### How do I use PyTorch with Anaconda?
143143

144144
Create a new conda environment named torch, install PyTorch, and activate the new environment.
145145

content/install-guides/ansible.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ sudo add-apt-repository --yes --update ppa:ansible/ansible
6161
sudo apt install ansible -y
6262
```
6363

64-
## Install Ansible for macOS
64+
## How do I install Ansible for macOS?
6565

6666
You can use the `brew` package manager to install on `arm64`:
6767

6868
```console
6969
brew install ansible
7070
```
7171

72-
## Confirm installation
72+
## How do I confirm the installation?
7373

7474
Confirm the Ansible command line tools are installed by running:
7575

content/install-guides/aperf.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ APerf was created by AWS to help with Linux performance analysis.
1919

2020
In addition to the CLI, APerf includes an HTML view to visualize the collected data.
2121

22-
## Before you begin
22+
## What should I do before I begin installing APerf?
2323

2424
APerf works on Linux, and is available as a single binary.
2525

@@ -41,7 +41,7 @@ aarch64
4141

4242
If you see a different result, you are not using an Arm computer running 64-bit Linux.
4343

44-
## Download and install APerf
44+
## How do I download and install APerf?
4545

4646
The easiest way to install APerf is to download a release from GitHub, extract it, and setup your `PATH` environment variable or copy the executable to a directory already in your search path.
4747

@@ -84,9 +84,9 @@ The output should print the version:
8484
aperf 0.1.0 (4b910d2)
8585
```
8686

87-
## Verify APerf is working
87+
## How do I verify APerf is working?
8888

89-
### Create and view a report
89+
### How do I create and view a report?
9090

9191
To confirm APerf is working, start it for 10 seconds and take a sample every 1 second.
9292

@@ -120,7 +120,7 @@ You can browse the data and see what has been collected.
120120
The Kernel Config and Sysctl Data tabs are blank unless you click No.
121121
{{% /notice %}}
122122

123-
### Create and view a report containing 2 runs
123+
### How do I create and view a report containing 2 runs?
124124

125125
To demonstrate comparing 2 runs, create a second run with `aperf record`:
126126

@@ -144,7 +144,7 @@ A screenshot is shown below:
144144

145145
![APerf #center](/install-guides/_images/aperf.png)
146146

147-
### Use an HTTP server
147+
### How do I use an HTTP server to view reports?
148148

149149
If you are doing performance analysis on a remote system or cloud instance without a remote desktop, you can view the APerf reports from your local browser by running a simple web server on the remote machine.
150150

content/install-guides/arduino-pico.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ You can install the Arduino IDE and Arduino core software for the Raspberry Pi P
2424

2525
Arduino core is the software stack that powers Arduino devices and development boards. While the Raspberry Pi Pico isn't an Arduino board, it uses the same RP2040 SoC as the Arduino RP2040 Connect, and therefore can run the same Arduino core software.
2626

27-
## Install Arduino IDE
27+
## How do I install Arduino IDE?
2828

2929
First, you need to install the Arduino IDE on your laptop or desktop. You can download it for your operating system from [the Arduino Software website](https://www.arduino.cc/en/software). Follow the provided instructions for installing the IDE.
3030

3131
Start the IDE by clicking the Arduino IDE icon.
3232

33-
## Install board support package
33+
## How do I install the board support package?
3434

3535
The Arduino software is comprised of the core libraries and a Board Support Package that is specific to your device. You need to install the `Arduino Mbed OS RP2040 Boards` package to support the Raspberry Pi Pico.
3636

@@ -42,7 +42,7 @@ When the `Boards Manager` opens search for `pico` and the `Arduino Mbed OS RP204
4242

4343
![Arduino Board Manager](/install-guides/_images/arduino_rp2040_boards.png)
4444

45-
### Raspberry Pi Pico W
45+
### How do I set up the Raspberry Pi Pico W?
4646

4747
The `Boards Manager` package for for `Arduino Mbed OS RP2040 Boards` does not include the Raspberry Pi Pico W.
4848

@@ -54,13 +54,13 @@ https://github.com/earlephilhower/arduino-pico/releases/download/global/package_
5454

5555
Return to `Tools -> Board -> Boards Manager` and search for `pico` and you will see a new entry `Raspberry Pi Pico/RP2040`. Click the `Install` button to add it to the Arduino IDE.
5656

57-
## Select your board
57+
## How do I select my board?
5858

5959
Once the support package is installed, you need to tell the Arduino IDE which supported board you will be using. From the `Tools -> Board` menu, find and select `Raspberry Pi Pico` or `Raspberry Pi Pico W` depending on your board type.
6060

6161
![Arduino Board Selection](/install-guides/_images/arduino_rp2040_select.png)
6262

63-
## Upload to your board
63+
## How do I upload code to my board?
6464

6565
Because the Raspberry Pi Pico doesn't come with the Arduino core software installed, the Arduino IDE won't recognize it.
6666

0 commit comments

Comments
 (0)