From 3fd5981085ac6db4c54522746ab544478f4d446b Mon Sep 17 00:00:00 2001 From: Paulo Castro Date: Fri, 27 Aug 2021 22:30:59 +0100 Subject: [PATCH] Clarify installation instructions Change-type: patch --- INSTALL-LINUX.md | 6 +++++- INSTALL-MAC.md | 16 +++++++--------- INSTALL-WINDOWS.md | 16 +++++++--------- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/INSTALL-LINUX.md b/INSTALL-LINUX.md index fb74449d..f544336d 100644 --- a/INSTALL-LINUX.md +++ b/INSTALL-LINUX.md @@ -1,6 +1,10 @@ # balena CLI Installation Instructions for Linux -These instructions are suitable for most Linux distributions on Intel x86, except notably for **Linux Alpine** or **Busybox**. For these distros or for the ARM architecture, follow the [NPM Installation](./INSTALL-ADVANCED.md#npm-installation) method. +These instructions are suitable for most Linux distributions on Intel x86, such as +Ubuntu, Debian, Fedora, Arch Linux and other glibc-based distributions. +For the ARM architecture and for Linux distributions not based on glibc, such as +Alpine Linux, follow the [NPM Installation](./INSTALL-ADVANCED.md#npm-installation) +method. Selected operating system: **Linux** diff --git a/INSTALL-MAC.md b/INSTALL-MAC.md index 394efd3f..7cfa543d 100644 --- a/INSTALL-MAC.md +++ b/INSTALL-MAC.md @@ -10,16 +10,14 @@ Selected operating system: **macOS** Look for a file name that ends with "-installer.pkg": `balena-cli-vX.Y.Z-macOS-x64-installer.pkg` -2. Double click the downloaded file to run the installer. After the installation completes, - close and re-open any open [command - terminal](https://www.balena.io/docs/reference/cli/#choosing-a-shell-command-promptterminal) - windows (so that the changes made by the installer to the PATH environment variable can take - effect). +2. Double click on the downloaded file to run the installer and follow the installer's + instructions. -3. Check that the installation was successful by running the following commands on a - command terminal: - * `balena version` - should print the CLI's version - * `balena help` - should print a list of available commands +3. Check that the installation was successful: + - [Open the Terminal + app](https://support.apple.com/en-gb/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac). + - On the terminal prompt, type `balena version` and hit Enter. It should display + the version of the balena CLI that you have installed. No further steps are required to run most CLI commands. The `balena ssh`, `build`, `deploy` and `preload` commands may require additional software to be installed, as described diff --git a/INSTALL-WINDOWS.md b/INSTALL-WINDOWS.md index 485c37ce..0ff33c9a 100644 --- a/INSTALL-WINDOWS.md +++ b/INSTALL-WINDOWS.md @@ -10,16 +10,14 @@ Selected operating system: **Windows** Look for a file name that ends with "-installer.exe": `balena-cli-vX.Y.Z-windows-x64-installer.exe` -2. Double click the downloaded file to run the installer. After the installation completes, - close and re-open any open [command - terminal](https://www.balena.io/docs/reference/cli/#choosing-a-shell-command-promptterminal) - windows (so that the changes made by the installer to the PATH environment variable can take - effect). +2. Double click on the downloaded file to run the installer and follow the installer's + instructions. -3. Check that the installation was successful by running the following commands on a - command terminal: - * `balena version` - should print the CLI's version - * `balena help` - should print a list of available commands +3. Check that the installation was successful: + - Click on the Windows Start Menu, type PowerShell, and then click + on Windows PowerShell. + - On the command prompt, type `balena version` and hit Enter. It should display + the version of the balena CLI that you have installed. No further steps are required to run most CLI commands. The `balena ssh`, `scan`, `build`, `deploy` and `preload` commands may require additional software to be installed, as