Skip to content

Commit 085e0ac

Browse files
greg-fernordicjm
authored andcommitted
doc: install_ncs: minor improvements
Added direct links to Downloads in install_ncs/Installing prerequisites. Fixed a line for J-Link version in recommended_versions. Fixed a missing reference to an subdir in one step. Added "Alternative method" to two sections to clearly mark they are separate from the main installation method. TECHDOC-3429. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 8f5a6ce commit 085e0ac

File tree

3 files changed

+24
-17
lines changed

3 files changed

+24
-17
lines changed

doc/nrf/installation/install_ncs.rst

+19-16
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Installing the |NCS|
1111

1212
There are different ways to install the |NCS|, depending on your preferred development environment:
1313

14-
* Using |VSC| and the |nRFVSC| (recommended)
15-
* Using command line and nRF Util
14+
* Using |VSC| and the :ref:`requirements_nrfvsc` (recommended)
15+
* Using command line and :ref:`requirements_nrf_util`
1616

1717
Regardless of which way you choose, the following steps install the |NCS| source code and the |NCS| :term:`toolchain`.
1818
This includes everything that is required by Zephyr's :ref:`zephyr:getting_started` together with additional tools and Python dependencies that the |NCS| uses.
@@ -38,8 +38,7 @@ Before you start setting up the toolchain, install available updates for your :r
3838
Install prerequisites
3939
*********************
4040

41-
Depending on your preferred development environment, install the following required tools.
42-
41+
Depending on your preferred development environment, install the following software tools.
4342

4443
.. tabs::
4544

@@ -48,12 +47,13 @@ Depending on your preferred development environment, install the following requi
4847
* All operating systems:
4948

5049
* The latest version of the :ref:`requirements_clt` package.
51-
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Command Line Tools`_ page.
52-
* The |jlink_ver_vsc| of :ref:`SEGGER J-Link <requirements_jlink>`.
50+
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and `download the installer <nRF Command Line Tools Downloads_>`_.
51+
* The |jlink_ver_vsc| of SEGGER J-Link.
5352
Download it from the `J-Link Software and Documentation Pack`_ page.
5453
On Windows, `install it manually together with SEGGER USB Driver for J-Link <nRF Util prerequisites_>`_.
5554
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_.
5655
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_.
56+
The |nRFVSC| comes with its own bundled version of some of the nRF Util commands.
5757

5858
* Additionally, for Windows users: SEGGER USB Driver for J-Link, required for support of older Nordic Semiconductor devices in nRF Util.
5959
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
@@ -64,19 +64,19 @@ Depending on your preferred development environment, install the following requi
6464
* All operating systems:
6565

6666
* The latest version of nRF Util, a unified command-line utility for Nordic Semiconductor products.
67-
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Util development tool`_ page.
67+
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and `download the installer <nRF Util Downloads_>`_.
6868

6969
.. note::
7070
After downloading the nRF Util executable, move it to a directory that is in the system :envvar:`PATH`.
7171
On macOS and Linux, the downloaded file also needs to be given execute permission by typing `chmod +x nrfutil` or by checking the checkbox in the file properties.
7272

7373
* The latest version of the :ref:`requirements_clt` package.
74-
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Command Line Tools`_ page.
74+
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and `download the installer <nRF Command Line Tools Downloads_>`_.
7575

7676
.. note::
7777
After downloading and installing the tools, add nrfjprog to the system :envvar:`PATH` in the environment variables.
7878

79-
* The |jlink_ver| of :ref:`SEGGER J-Link <requirements_jlink>`.
79+
* The |jlink_ver| of SEGGER J-Link.
8080
Download it from the `J-Link Software and Documentation Pack`_ page.
8181
On Windows, `install it manually together with SEGGER USB Driver for J-Link <nRF Util prerequisites_>`_.
8282

@@ -93,7 +93,7 @@ Install the |NCS| toolchain
9393
***************************
9494

9595
The |NCS| :term:`toolchain` includes the Zephyr SDK and then adds tools and modules required to build |NCS| samples and applications on top of it.
96-
These include the :ref:`required tools <requirements_toolchain_tools>`, the :ref:`Python dependencies <requirements_toolchain_python_deps>`, and the :ref:`GN tool <ug_matter_gs_tools_gn>` for creating :ref:`ug_matter` applications.
96+
These include the :ref:`required SDK tools <requirements_toolchain_tools>`, the :ref:`Python dependencies <requirements_toolchain_python_deps>`, and the :ref:`GN tool <ug_matter_gs_tools_gn>` for creating :ref:`ug_matter` applications.
9797

9898
.. note::
9999
When you first install the |NCS|, it is recommended to install the latest released, stable versions of the SDK and the toolchain.
@@ -281,7 +281,10 @@ For more information about the repository and development model, see the :ref:`d
281281
282282
west init -m https\://github.com/nrfconnect/sdk-nrf --mr *nRFConnectSDK_revision* *nRFConnectSDK_revision*
283283
284-
In this command, the first *nRFConnectSDK_revision* identifies the revision of the |NCS| and the second *nRFConnectSDK_revision* is the name of the workspace directory that will be created by west.
284+
In this command:
285+
286+
- The first *nRFConnectSDK_revision* identifies the revision of the |NCS|.
287+
- The second *nRFConnectSDK_revision* is the name of the workspace directory that will be created by west.
285288

286289
The command creates the *nRFConnectSDK_revision* subdirectory and checks out the given revision of the |NCS| inside it.
287290
For example:
@@ -319,7 +322,7 @@ For more information about the repository and development model, see the :ref:`d
319322

320323
.. west-error-end
321324
322-
#. Enter the following command to clone the project repositories:
325+
#. Enter the *nRFConnectSDK_revision* subdirectory and run the following command to clone the project repositories:
323326

324327
.. code-block:: console
325328
@@ -421,8 +424,8 @@ Define the required environment variables as follows, depending on your operatin
421424

422425
.. _additional_deps:
423426

424-
System-wide installation
425-
************************
427+
Alternative method: System-wide installation
428+
********************************************
426429

427430
System-wide installation is an alternative to the recommended installation methods using the |nRFVSC| or nRF Util.
428431
It gives you more control over each of the required tools, but requires more familiarity with Zephyr and with each of the tools.
@@ -643,8 +646,8 @@ To install the |NCS| system-wide, complete the following steps:
643646
.. _gs_assistant:
644647
.. _auto_installation_tcm_setup:
645648

646-
Installation with Toolchain Manager
647-
***********************************
649+
Alternative method: Installation with Toolchain Manager
650+
*******************************************************
648651

649652
Toolchain Manager is an SDK and toolchain installer for the |NCS|.
650653
It is available from `nRF Connect for Desktop`_, a cross-platform tool that provides different development applications for the |NCS| and Nordic Semiconductor products.

doc/nrf/installation/recommended_versions.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ J-Link Software and Documentation Pack
285285
SEGGER's `J-Link Software and Documentation Pack`_ is a package of tools that is required for SEGGER J-Link to work correctly with both Intel and ARM assemblies.
286286
Among others, this package includes the J-Link RTT Viewer, which can be used for :ref:`test_and_optimize`.
287287

288-
It is recommended to use the |jlink_ver| of the package when you :ref:`installing_vsc`.
288+
For the SEGGER J-Link version to use with your preferred development environment, see the :ref:`installing_vsc` section on the |NCS| installation page.
289289

290290
On Windows, you also need to install SEGGER USB Driver for J-Link, which is required for support of older Nordic Semiconductor devices in :ref:`requirements_nrf_util`.
291291
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
@@ -383,6 +383,8 @@ For more information on nrfjprog, see `Programming SoCs with nrfjprog`_.
383383

384384
It is recommended to use the latest version of the package when you :ref:`installing_vsc`.
385385

386+
.. _requirements_nrfvsc:
387+
386388
nRF Connect for Visual Studio Code
387389
==================================
388390

doc/nrf/links.txt

+2
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,10 @@
395395
.. _`nRF5x Command Line Tools Windows 32`:
396396
.. _`nRF5x Command Line Tools Windows 64`:
397397
.. _`nRF5x Command Line Tools OSX`: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools
398+
.. _`nRF Command Line Tools Downloads`: https://www.nordicsemi.com/Products/Development-tools/nRF-Command-Line-Tools/Download?lang=en#infotabs
398399

399400
.. _`nRF Util development tool`: https://www.nordicsemi.com/Products/Development-tools/nrf-util
401+
.. _`nRF Util Downloads`: https://www.nordicsemi.com/Products/Development-tools/nRF-Util/Download#infotabs
400402

401403
.. _`nRF Connect for Desktop`: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-desktop
402404
.. _`Download nRF Connect for Desktop`: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-desktop/Download#infotabs

0 commit comments

Comments
 (0)