Skip to content

Commit

Permalink
doc: install: edits from review
Browse files Browse the repository at this point in the history
Applied edits from the recent getting started testing.
Requested by @ihansse and tracked in NCSDK-27019.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
  • Loading branch information
greg-fer authored and gmarull committed Apr 13, 2024
1 parent e34fd6c commit e66b76a
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 24 deletions.
8 changes: 6 additions & 2 deletions doc/nrf/create_application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,16 @@ Use the following steps depending on the application placement:
When the application is created, a VS Code prompt appears.
#. Click :guilabel:`Open`.
This opens the new application and adds it to the :guilabel:`Applications View` in the extension.
At this point, you have created a freestanding application.
#. Add the :file:`west.yml` to create a west workspace around the application:

a. In the :guilabel:`Welcome View`, click the :guilabel:`Manage SDKs` action.
A quick pick menu appears.
#. Click :guilabel:`Create west workspace`.
#. Enter a location for the :file:`west.yml` file that matches the location provided in step 4.
#. Select the SDK version for the west workspace.
The west workspace is initialized and the :guilabel:`Manage SDKs` action changes to :guilabel:`Open west manifest`.
#. In the :guilabel:`Applications View`, click the :guilabel:`Run West Update` button to update the workspace modules.
The west workspace is initialized and the :guilabel:`Manage SDKs` action changes to :guilabel:`Manage west workspace`.
#. Click :guilabel:`Manage west workspace` and select :guilabel:`West Update` button to update the workspace modules.

You can now start :ref:`configuring and building <configuration_and_build>` the application.

Expand Down Expand Up @@ -167,6 +168,9 @@ Use the following steps depending on the application placement:

See the `extension documentation <Create a new application_>`_ for more information about creating freestanding applications in the extension.

.. note::
You can transform your freestanding application into a workspace application at any moment by completing the step 7 under the Workspace application tab.

.. _creating_cmd:

Creating application for use with command line
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ This repository is the manifest repository, because it contains the SDK's :ref:`
:maxdepth: 2
:caption: Subpages:

installation/recommended_versions
installation/install_ncs
installation/updating
installation/recommended_versions
9 changes: 7 additions & 2 deletions doc/nrf/installation/install_ncs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,12 @@ Update operating system
***********************

Before you start setting up the toolchain, install available updates for your operating system.
See :ref:`requirements` for information on the supported operating systems.

.. include:: ./recommended_versions.rst
:start-after: os_table_start
:end-before: os_table_end

See :ref:`supported_OS` for more information about the tier definitions.

.. _installing_vsc:

Expand All @@ -34,7 +39,7 @@ See :ref:`requirements` for information on the supported operating systems.
Install prerequisites
*********************

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

.. tabs::

Expand Down
56 changes: 37 additions & 19 deletions doc/nrf/installation/recommended_versions.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
.. _gs_recommended_versions:
.. _requirements:
.. _gs_supported_OS:
.. _supported_OS:

Requirements
############
Requirements reference
######################

.. contents::
:local:
:depth: 2

This page summarizes the requirements for installing and working with the |NCS|.
All of these requirements are installed when you :ref:`install the nRF Connect SDK <install_ncs>`.

.. _gs_supported_OS:
.. _supported_OS:

Supported operating systems
***************************

The |NCS| supports Microsoft Windows, Linux, and macOS for development.
The following table shows the operating system versions that support the |NCS| tools:

.. os_table_start
.. list-table::
:header-rows: 1

Expand Down Expand Up @@ -57,6 +66,8 @@ The following table shows the operating system versions that support the |NCS| t
- Tier 3
- Not supported

.. os_table_end
Tier definitions
The table uses several tier definitions to categorize the level of operating system support:

Expand Down Expand Up @@ -95,6 +106,7 @@ Zephyr features only available on Linux
***************

The |NCS| :term:`toolchain` includes the Zephyr SDK and adds the necessary tools and modules to create |NCS| samples and applications on top of it.
The |NCS| toolchain is installed as one of the steps when :ref:`install_ncs`.

.. note::

Expand Down Expand Up @@ -187,32 +199,35 @@ Other versions might also work, but are not verified.
* - :ref:`west <ncs_west_intro>`
- :ncs-tool-version:`WEST_VERSION_DARWIN`

To check the list of installed packages and their versions, run the following command:
Checking tool versions
.. toggle::

.. tabs::
To check the list of installed packages and their versions, run the following command:

.. group-tab:: Windows
.. tabs::

.. code-block:: console
.. group-tab:: Windows

choco list -lo
.. code-block:: console
.. group-tab:: Linux
choco list -lo
.. code-block:: console
Chocolatey is installed as part of the Zephyr SDK toolchain when you :ref:`install the nRF Connect SDK <install_ncs>`.

apt list --installed
.. group-tab:: Linux

This command lists all packages installed on your system.
To list the version of a specific package, type its name and add ``--version``.
.. code-block:: console
.. group-tab:: macOS
apt list --installed
.. code-block:: console
This command lists all packages installed on your system.
To list the version of a specific package, type its name and add ``--version``.

brew list --versions
.. group-tab:: macOS

.. code-block:: console
brew list --versions
.. _requirements_toolchain_python_deps:

Expand Down Expand Up @@ -269,8 +284,8 @@ Building and running applications, samples, and tests
Building documentation
----------------------

Python documentation dependencies are listed in the following table. They can
all be installed using the ``doc/requirements.txt`` file using ``pip``.
Python documentation dependencies are listed in the following table.
They can all be installed using the ``doc/requirements.txt`` file using ``pip``.

.. list-table::
:header-rows: 1
Expand Down Expand Up @@ -322,12 +337,15 @@ Among others, this package includes the following prerequisites for the |NCS|:
* nrfjprog executable and library, which the west command uses by default to program the development kits.
For more information on nrfjprog, see `Programming SoCs with nrfjprog`_.

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

.. _toolchain_management_tools:

|NCS| toolchain management tools
********************************

Nordic Semiconductor provides proprietary |NCS| toolchain management tools that streamline the process of installing the |NCS| and its toolchain.
Depending on your development environment, you need to install only some of them when you :ref:`installing_vsc`.

|nRFVSC|
========
Expand Down

0 comments on commit e66b76a

Please sign in to comment.