Skip to content

Commit

Permalink
doc: install: update TM note plus minor fixes
Browse files Browse the repository at this point in the history
Updated the note about Toolchain Manager.
Applied minor fixes to different areas.
NCSDK-29557.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
  • Loading branch information
greg-fer committed Oct 8, 2024
1 parent 4a34c90 commit dc2a2b7
Showing 1 changed file with 31 additions and 25 deletions.
56 changes: 31 additions & 25 deletions doc/nrf/installation/install_ncs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,31 +46,37 @@ Depending on your preferred development environment, install the following requi

.. group-tab:: nRF Connect for Visual Studio Code

* The latest version of the :ref:`requirements_clt` package.
Download it from the `nRF Command Line Tools`_ page.
* The |jlink_ver| of :ref:`SEGGER J-Link <requirements_jlink>`.
Download it from the `J-Link Software and Documentation Pack`_ page.
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_.
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_.
* Linux users: `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.
* All operating systems:

* The latest version of the :ref:`requirements_clt` package.
Download it from the `nRF Command Line Tools`_ page.
* The |jlink_ver| of :ref:`SEGGER J-Link <requirements_jlink>`.
Download it from the `J-Link Software and Documentation Pack`_ page.
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_.
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_.

* Additionally for Linux users: `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.

.. group-tab:: Command line

* The latest version of `nRF Util development tool`_, a unified command line utility for Nordic products.
* All operating systems:

* The latest version of `nRF Util development tool`_, a unified command line utility for Nordic products.

.. note::
After downloading the nRF Util executable, move it to a directory that is in the system :envvar:`PATH`.
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.
.. note::
After downloading the nRF Util executable, move it to a directory that is in the system :envvar:`PATH`.
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.

* The latest version of the :ref:`requirements_clt` package.
Download it from the `nRF Command Line Tools`_ page.
* The latest version of the :ref:`requirements_clt` package.
Download it from the `nRF Command Line Tools`_ page.

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

.. note::
After downloading and installing the tools, add nrfjprog to the system :envvar:`PATH` in the environment variables.
* The |jlink_ver| of :ref:`SEGGER J-Link <requirements_jlink>`.
Download it from the `J-Link Software and Documentation Pack`_ page.

* The latest version of :ref:`SEGGER J-Link <requirements_jlink>`.
Download it from the `J-Link Software and Documentation Pack`_ page.
* Linux users: `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.
* Additionally for Linux users: `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.

.. _gs_installing_toolchain:
.. _gs_installing_tools:
Expand All @@ -83,7 +89,8 @@ Install the |NCS| toolchain
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.
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.

When you first install the |NCS|, it is recommended to install the latest released versions of the SDK and the toolchain.
.. note::
When you first install the |NCS|, it is recommended to install the latest released, stable versions of the SDK and the toolchain.

Depending on your preferred development environment, complete the following steps:

Expand Down Expand Up @@ -186,7 +193,7 @@ Simply put, you can work with the following versions of the |NCS|:
- `sdk-nrf`_ repository

.. note::
Unless you are familiar with the :ref:`development process <dev-model>`, you should always work with a specific release of the |NCS|.
Unless you are familiar with the :ref:`development process <dev-model>`, you should always work with a specific, stable release of the |NCS|.

For more information about the repository and development model, see the :ref:`dm_code_base` page.

Expand Down Expand Up @@ -611,16 +618,15 @@ To install the |NCS| system-wide, complete the following steps:
Installation with Toolchain Manager
***********************************

.. note::
Toolchain Manager is a tool available from `nRF Connect for Desktop`_, a cross-platform tool that provides different applications that simplify installing the |NCS|.
Both the tool and the application are available for Windows, Linux, and macOS.

.. note::
The Toolchain Manager installation is recommended only when using the nRF54H20 DK with the |NCS| v2.7.0.
When using any other DK, the Toolchain Manager installation is recommended for the |NCS| v1.9.x and earlier versions.
Since the release of |NCS| v2.0.0, the |nRFVSC| is the recommended IDE for manaaging the |NCS| Toolchain and working with the |NCS|.

.. toggle::

Toolchain Manager is a tool available from `nRF Connect for Desktop`_, a cross-platform tool that provides different applications that simplify installing the |NCS|.
Both the tool and the application are available for Windows, Linux, and macOS.

To install the toolchain and the SDK using the Toolchain Manager app, complete the following steps:

1. Install Toolchain Manager:
Expand Down

0 comments on commit dc2a2b7

Please sign in to comment.