Skip to content

Commit 0529658

Browse files
greg-ferRuth Fuchss
authored andcommitted
doc: add gs assistant installation page
Added GS Assistant page and edited cross-links. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 84a2ed2 commit 0529658

File tree

9 files changed

+84
-9
lines changed

9 files changed

+84
-9
lines changed

doc/nrf/getting_started.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Getting started
44
###############
55

6-
To quickly get started with the |NCS|, use the `Getting Started Assistant <Getting Started Information_>`_ to set up your development environment.
6+
To quickly get started with the |NCS|, use the :ref:`Getting Started Assistant <gs_assistant>` to set up your development environment.
77
Alternatively, check the :ref:`gs_installing` section for instructions on setting up your environment manually.
88

99
We recommend using SEGGER Embedded Studio for building your applications. See :ref:`gs_programming` for the download links and instructions.
@@ -16,6 +16,7 @@ After that, pick a sample that is related to the application you want to create
1616
.. toctree::
1717
:maxdepth: 2
1818

19+
gs_assistant
1920
gs_installing
2021
gs_programming
2122
gs_testing

doc/nrf/gs_assistant.rst

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
.. _gs_assistant:
2+
3+
Installing the |NCS| with the |GSA|
4+
###################################
5+
6+
The |GSA| application provides you with step-by-step instructions for installing the toolchain for |NCS|.
7+
8+
The application allows you to check which of the required tools are already installed on your computer and verify the installation.
9+
It also guides you through installing the parts of the toolchain that you are missing.
10+
In addition, it will help you clone the |NCS| repositories and set up your first project in |SES|.
11+
12+
.. _gs_assistant_installing-gsa:
13+
14+
Installing the |GSA|
15+
********************
16+
17+
The |GSA| app is available in `nRF Connect for Desktop`_, a cross-platform tool available for Windows, Linux, and macOS.
18+
19+
To install the Assistant app, complete the following steps:
20+
21+
.. _assistant_setup:
22+
23+
1. `Download nRF Connect for Desktop`_ for your operating system.
24+
#. Install and run the tool on your machine.
25+
#. In the APPS section, click :guilabel:`Install` next to |GSA|.
26+
27+
.. figure:: images/gs-assistant_installation.PNG
28+
:alt: The nRF Connect for Desktop main window
29+
30+
The nRF Connect for Desktop main window
31+
32+
The app is installed on your machine, and the :guilabel:`Install` button changes to :guilabel:`Open`.
33+
34+
.. _gs_assistant_installing-ncs:
35+
36+
Installing the |NCS|
37+
********************
38+
39+
Once you have installed |GSA|, open it in nRF Connect for Desktop.
40+
The |GSA| app opens with the Overview section displayed in the main window.
41+
42+
You can now go through each of the sections and complete the listed installation steps.
43+
44+
To provide installation variables, use the Variables section.
45+
If you need to edit any of the fields, click on it.
46+
47+
.. figure:: images/gs-assistant_variables.PNG
48+
:alt: The Variables section of the |GSA| app main window, cropped
49+
50+
The Variables section
51+
52+
.. _gs_assistant_installing-ncs_verify:
53+
54+
Verification options
55+
====================
56+
57+
Next to each step, you can use one or both of the following buttons:
58+
59+
- :guilabel:`Mark done` -- marks a step as completed.
60+
- :guilabel:`Verify` -- checks if the installation is correct.
61+
62+
The verification process is reflected in the vertical progress bar animation.
63+
Once the verification is successful, the vertical progress bar changes color to green and the Log section is updated.
64+
At the same time, the :guilabel:`Mark done` button changes to :guilabel:`Mark not done`.
65+
66+
.. figure:: images/gs-assistant_UI.gif
67+
:alt: Verifying the |NCS| toolchain installation in the |GSA| app
68+
69+
Verifying the |NCS| toolchain installation
70+
71+
If there is an issue, the Log section is updated with the related error.
72+
73+
.. figure:: images/gs-assistant_log.PNG
74+
:alt: The Log section of the |GSA| app main window with an error highlighted in red, cropped
75+
76+
The Log section with an error highlighted in red

doc/nrf/gs_installing.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
.. _gs_installing:
22

33

4-
Installing the |NCS|
5-
####################
4+
Installing the |NCS| manually
5+
#############################
66

77
The recommended way to get started with the |NCS| is to run the Getting Started Assistant app in nRF Connect for Desktop.
8-
See the `Getting Started information`_ on the nRF9160 DK product page for information about how to install the Getting Started Assistant.
9-
10-
The Getting Started Assistant checks which of the required tools are already installed on your computer and guides you through installing the parts of the toolchain that you are missing.
11-
In addition, it will help you clone the |NCS| repositories and set up your first project in |SES|.
8+
See the :ref:`gs_assistant` section for information about how to install the Getting Started Assistant.
129

1310
.. note::
1411
If you use the Getting Started Assistant, you can skip this section of the documentation.

doc/nrf/images/gs-assistant_UI.gif

1.35 MB
Loading
34 KB
Loading
26.9 KB
Loading
6.7 KB
Loading

doc/nrf/links.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,6 @@
6060

6161
.. _`DevZone`: https://devzone.nordicsemi.com/
6262

63-
.. _`Getting Started information`: https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF9160-DK/GetStarted#infotabs
64-
6563
.. _`nRF9160 DK product page`: https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF9160-DK/Download#infotabs
6664

6765
.. _`nRF9160 product website`: https://www.nordicsemi.com/Products/Low-power-cellular-IoT/nRF9160-SiP
@@ -83,6 +81,7 @@
8381
.. _`nRF5x Command Line Tools OSX`: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF5-Command-Line-Tools
8482

8583
.. _`nRF Connect for Desktop`: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-desktop
84+
.. _`Download nRF Connect for Desktop`: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-desktop/Download#infotabs
8685

8786
.. _`nRF Connect for Mobile`: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-mobile
8887

doc/nrf/shortcuts.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@
99

1010
.. |connect_terminal_specific| replace:: Connect to the board that runs this sample with a terminal emulator (for example, PuTTY).
1111
See :ref:`putty` for the required settings.
12+
13+
.. |GSA| replace:: Getting Started Assistant

0 commit comments

Comments
 (0)