Skip to content

Commit

Permalink
doc: install_ncs: align with Dev Academy
Browse files Browse the repository at this point in the history
Aligned installation steps with the Dev Academy exercise.
Requested by stakeholders.

Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
greg-fer authored and rlubos committed Feb 6, 2024
1 parent 2153821 commit 3918857
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
13 changes: 8 additions & 5 deletions doc/nrf/installation/install_ncs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ There are different ways to install the |NCS|, depending on your preferred devel
Regardless of which way you choose, the following steps install the |NCS| source code and the |NCS| :term:`toolchain`.
This includes everything that is required by Zephyr's :ref:`zephyr:getting_started` together with additional tools and Python dependencies that the |NCS| uses.

Using |VSC| and the |nRFVSC| is also covered in the `Installing nRF Connect SDK and VS Code`_ exercise of the `nRF Connect SDK Fundamentals course`_ on Nordic Developer Academy.

.. rst-class:: numbered-step

Update operating system
Expand All @@ -32,16 +34,16 @@ See :ref:`requirements` for information on the supported operating systems.
Install prerequisites
*********************

Depending on your preferred development environment, install the following tools:
Depending on your preferred development environment, install the required tools:

.. tabs::

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

* 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`_.
* The latest version of the :ref:`requirements_clt` package.
Download it from the `nRF Command Line Tools`_ 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`_.

.. group-tab:: Command line

Expand Down Expand Up @@ -77,15 +79,16 @@ Depending on your preferred development environment, complete the following step
.. group-tab:: nRF Connect for Visual Studio Code

1. Open the nRF Connect extension in |VSC| by clicking its icon in the :guilabel:`Activity Bar`.
#. In the extension's :guilabel:`Welcome View`, click on :guilabel:`Manage toolchains`.
#. In the SDK management menu, click :guilabel:`Install Toolchain`.
#. In the extension's :guilabel:`Welcome View`, click on :guilabel:`Install Toolchain`.
#. Select the toolchain version to install.
The toolchain version should match the |NCS| version you are going to work with.
If you have received a custom URL for installing the toolchain, you can provide it using the :guilabel:`Change Toolchain Index` button in the quick pick's header.
The toolchain installation starts in the background, as can be seen in the notification that appears.

When you install the toolchain for the first time, the installed version is automatically selected for your project.

After installing the toolchain, you can access the :guilabel:`Install Toolchain` option by clicking on :guilabel:`Manage toolchains`.

.. group-tab:: Command line

1. Open a terminal window.
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,8 @@
.. _`Nordic Developer Academy`: https://academy.nordicsemi.com/

.. _`nRF Connect SDK Fundamentals course`: https://academy.nordicsemi.com/courses/nrf-connect-sdk-fundamentals/
.. _`Installing nRF Connect SDK and VS Code`: https://academy.nordicsemi.com/courses/nrf-connect-sdk-fundamentals/lessons/lesson-1-nrf-connect-sdk-introduction/topic/exercise-1-1/

.. _`Cellular IoT Fundamentals course`: https://academy.nordicsemi.com/courses/cellular-iot-fundamentals/
.. _`Power saving techniques`: https://academy.nordicsemi.com/courses/cellular-iot-fundamentals/lessons/lesson-1-cellular-fundamentals/topic/lesson-1-power-saving-techniques/
.. _`Bluetooth LE Fundamentals course`: https://academy.nordicsemi.com/courses/bluetooth-low-energy-fundamentals/
Expand Down

0 comments on commit 3918857

Please sign in to comment.