|
| 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 |
0 commit comments