Skip to content

Commit d4fbfa1

Browse files
committed
Change install guide headings to questions
1 parent 870693a commit d4fbfa1

File tree

14 files changed

+36
-39
lines changed

14 files changed

+36
-39
lines changed

content/install-guides/acfl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ If you wish to install just the Arm Performance Libraries, use:
293293
spack install armpl-gcc
294294
```
295295

296-
### How do I set up the environment for ACfL with Spack?
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-
## How do I get started with the Arm C/C++ compiler in ACfL? {#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

content/install-guides/armclang.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ weight: 1
2323

2424
A safety qualified branch of Arm Compiler for Embedded, known as [Arm Compiler for Embedded FuSa](https://developer.arm.com/Tools%20and%20Software/Arm%20Compiler%20for%20Embedded%20FuSa), is available for safety critical applications.
2525

26-
## How can I access Arm Compiler for Embedded through other tools?
26+
## How can I access Arm Compiler for Embedded from Arm Development Studio?
2727

2828
The easiest way to access the Arm Compiler for Embedded is to use the version provided with [Arm Development Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio).
2929

@@ -39,7 +39,7 @@ Arm Compiler for Embedded FuSa must also be [downloaded separately](#download).
3939

4040
Individual compiler packages for all supported host platforms can be downloaded from the [Arm Product Download Hub](#pdh) or the [Arm Tools Artifactory](#artifactory).
4141

42-
### How do I download from the Product Download Hub? {#pdh}
42+
### How do I download Arm Compiler for Embedded from the Product Download Hub? {#pdh}
4343

4444
All compiler packages can be downloaded from the [Arm Product Download Hub](https://developer.arm.com/downloads) (requires login).
4545

@@ -87,7 +87,7 @@ set path=(/home/$USER/ArmCompilerforEmbedded6.22/bin $path)
8787
armclang --version
8888
```
8989

90-
### How do I download from the Arm Tools Artifactory? {#artifactory}
90+
### How do I download Arm Compiler for Embedded from the Arm Tools Artifactory? {#artifactory}
9191

9292
The Arm Compiler for Embedded, as well as other tools and utilities are available in the [Arm Tools Artifactory](https://www.keil.arm.com/artifacts/). The Keil Studio VS Code [Extensions](../keilstudio_vs) use the artifactory to fetch and install and the necessary components.
9393

content/install-guides/armpl.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ These libraries are free to use and do not require a license. They can be instal
3737

3838
Arm Performance Libraries are available for use on [Windows 11 on Arm](#windows), [macOS](#macos) (Apple Silicon), and [Linux](#linux) (AArch64) hosts.
3939

40-
## How do I install on Windows? {#windows}
40+
## How do I install Arm Performance Libraries on Windows? {#windows}
4141

4242
On your Windows 11 Arm machine, go to the [Arm Performance Libraries download page](https://developer.arm.com/downloads/-/arm-performance-libraries).
4343
Click on the Download Windows section and download the Windows Installer:
@@ -68,7 +68,7 @@ You can now start linking your application to the Arm Performance libraries on y
6868
For more information refer to [Get started with Arm Performance Libraries](https://developer.arm.com/documentation/109361).
6969

7070

71-
## How do I install on macOS? {#macos}
71+
## How do I install Arm Performance Libraries on macOS? {#macos}
7272

7373
[Download](https://developer.arm.com/downloads/-/arm-performance-libraries) the appropriate package for your macOS distribution.
7474

@@ -105,11 +105,11 @@ To get started, compile and test the examples included in the `/opt/arm/<armpl_d
105105
For more information refer to [Get started with Arm Performance Libraries](https://developer.arm.com/documentation/109362).
106106

107107

108-
## How do I install on Linux? {#linux}
108+
## How do I install Arm Performance Libraries on Linux? {#linux}
109109

110110
Arm Performance Libraries are supported on most Linux distributions like Ubuntu, RHEL, SLES and Amazon Linux on an `AArch64` host and compatible with various versions of GCC, LLVM, and NVHPC. The GCC compatible releases are built with GCC 14 and tested with GCC versions 7 to 14. The LLVM compatible releases are tested with LLVM 19.1. The NVHPC compatible releases are tested with NVHPC 24.7.
111111

112-
### How do I manually download and install on Linux?
112+
### How do I manually download and install Arm Performance Libraries on Linux?
113113

114114
[Download](https://developer.arm.com/downloads/-/arm-performance-libraries) the appropriate package for your Linux distribution. The deb based installers can be used on Ubuntu 20 and Ubuntu 22. The RPM based installers can be used on the following supported distributions:
115115

@@ -141,7 +141,7 @@ Using the `--accept` switch you automatically accept the End User License Agreem
141141

142142
If you want to change the installation directory location use the `--install-to` option with the script and provide the desired directory location.
143143

144-
## How do I download and install using system packages on Linux?
144+
## How do I download and install Arm Performance Libraries using system packages on Linux?
145145

146146
Arm Performance Libraries are available to install using Linux system package managers. The instructions shown below are for the Ubuntu system package manager `apt` command.
147147

@@ -161,7 +161,7 @@ Download and install Arm Performance Libraries with:
161161
sudo apt install arm-performance-libraries
162162
```
163163

164-
### How do I set up the environment on Linux?
164+
### How do I set up the environment for Arm Performance Libraries on Linux?
165165

166166
Install environment modules on your machine:
167167

content/install-guides/avh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ To do this, add the parameter `se.cryptocell.DISABLE_DEVICE=1` to your launch co
106106
FVP_Corstone-1000 -C se.cryptocell.DISABLE_DEVICE=1 ...
107107
```
108108

109-
## How do I use Arm Virtual Hardware 3rd Party? {#thirdparty}
109+
## How do I use Arm Virtual Hardware 3rd Party targets? {#thirdparty}
110110

111111
A valid [Arm AVH account](https://www.arm.com/resources/contact-us/virtual-hardware-boards) is required.
112112

content/install-guides/cmake.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This article provides quick instructions to install CMake for Arm Linux distribu
3636

3737
Confirm you are using a Windows on Arm device such as the Lenovo ThinkPad X13s or Surface Pro 9 with 5G.
3838

39-
### How do I prepare to install CMake for Arm Linux distributions?
39+
### How do I prepare to install CMake on Arm Linux distributions?
4040

4141
Confirm you are using an Arm computer with 64-bit Linux by running:
4242

@@ -52,7 +52,7 @@ aarch64
5252

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

55-
## How do I download and install on Windows on Arm?
55+
## How do I download and install CMake on Windows on Arm?
5656

5757
Native CMake support for Windows on Arm is available starting with version 3.24. Installers are available now from the [CMake download](https://cmake.org/download/) page. Emulated CMake can be used but is no longer needed unless an older version of CMake must be used.
5858

@@ -74,11 +74,11 @@ Wait for the installer to complete and click `Finish`:
7474

7575
![Install #center](/install-guides/_images/cmake-finish.png)
7676

77-
## How do I download and install on Linux?
77+
## How do I download and install CMake on Linux?
7878

7979
There are multiple ways to install CMake on Linux.
8080

81-
### How do I use the package manager?
81+
### How do I install CMake using the package manager?
8282

8383
Use `apt` on Ubuntu and Debian to install:
8484

@@ -95,7 +95,7 @@ sudo dnf install cmake -y
9595

9696
Depending on your Linux distribution you may have a version of `cmake` which is too old or too new for your project.
9797

98-
### How do I use Snap?
98+
### How do I install the CMake Snap?
9999

100100
Installing with `snap` provides the latest version of `cmake`:
101101

@@ -105,7 +105,7 @@ sudo snap install cmake --classic
105105

106106
With `snap` the `cmake` executable is installed in `/snap/bin` which should already be in your search path.
107107

108-
### How do I use a specific release from GitHub?
108+
### How do I use a specific CMake release from GitHub?
109109

110110
If you need a specific version look for it in the [GitHub releases area](https://github.com/Kitware/CMake/releases)
111111

content/install-guides/docker/docker-engine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The commands can also be used in the Windows Subsystem for Linux 2 (WSL 2) and o
3939
curl -fsSL get.docker.com -o get-docker.sh && sh get-docker.sh
4040
```
4141

42-
### How do I add my user to the Docker group?
42+
### How do I add my username to the Docker group?
4343

4444
Add the user to the docker group. The `newgrp` command avoids the need to logout and back in.
4545

content/install-guides/hyper-v.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,8 @@ The output should include the message:
9292
The operation completed successfully.
9393
```
9494

95-
## Do I need to restart after enabling Hyper-V?
96-
9795
Restart your computer to finish enabling Hyper-V.
9896

99-
10097
## How do I start Hyper-V?
10198

10299
Hyper-V Manager should now be available in the applications menu.

content/install-guides/keilstudio_vs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
3535

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

38-
## What should I do before I begin?
38+
## Where can I download Visual Studio Code?
3939

4040
[Download](https://code.visualstudio.com/download), install, and start `Visual Studio Code` on your desktop.
4141

@@ -61,7 +61,7 @@ If you have a commercial license for `Keil MDK` installed, decline this option.
6161

6262
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.
6363

64-
## Where can I find more extension information?
64+
## Where can I find more information about the Keil Studio extensions?
6565

6666
Use the table below to find additional information about the VS Code extensions.
6767

content/install-guides/license/ubl_license_admin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ sudo apt install -y openjdk-11-jre-headless python-is-python3
3333
```
3434
See [Hardware and software requirements](https://developer.arm.com/documentation/107573/latest/Installing-and-populating-the-license-server/Hardware-and-software-requirements) in the [User-based Licensing Administration Guide](https://developer.arm.com/documentation/107573).
3535

36-
### How do I download and install server software?
36+
### How do I download and install the server software?
3737

3838
The local license server (LLS) software can be downloaded from:
3939
```url
@@ -54,7 +54,7 @@ Waiting for license server... (up to 120 seconds, or press CTRL-C to stop waitin
5454
License server running and ready to accept requests at http://<external server name or IP address>:7070
5555
```
5656

57-
### How do I add the install directory to PATH?
57+
### How do I add the install directory to the search path?
5858

5959
It is recommended to add the server install directory to the `PATH` so that license server commands can be easily called. For example the default location:
6060
```console

content/install-guides/license/ubl_license_enduser.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
1515

1616
A [Local License Server (LLS)](/install-guides/license/ubl_license_admin/) must first be set up by your license administration team.
1717

18-
## How do I activate a license on my end user machine?
18+
## How do I activate a license on my computer?
1919

2020
The user-based license can be activated on the end user machine in different ways. Select the most appropriate for your needs.
2121

2222
* [Activate via environment variable](#envvar)
2323
* [Activate within tools IDE](#ide)
2424
* [Activate manually](#manual)
2525

26-
## How do I activate via environment variable? {#envvar}
26+
## How do I activate a license using an environment variable? {#envvar}
2727

2828
Create `ARMLM_ONDEMAND_ACTIVATION` environment variable referencing the product code and your internal license server. Contact your internal license administrators for information on your internal server.
2929

@@ -42,15 +42,15 @@ armclang --version
4242
```
4343
You can now [confirm your license has been checked out](#confirm).
4444

45-
## How do I activate within tools IDE? {#ide}
45+
## How do I activate a license from the tools IDE? {#ide}
4646

4747
The license can also be activated in the various Arm tool IDEs.
4848

4949
For example [Arm Development Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio), via `Help` > `Arm License Manager` > `Manage Arm User-Based Licenses`.
5050

5151
Select `Activate with` > `License Server`, and enter the appropriate license server address. Click `Query` to see what license types are available, and select the appropriate one from the pull down. Click `Activate`.
5252

53-
## How do I activate manually? {#manual}
53+
## How do I activate a license manually? {#manual}
5454

5555
Open a command prompt, and navigate to the bin directory of any user-based licensing enabled product.
5656

0 commit comments

Comments
 (0)