Skip to content

Commit 828b1eb

Browse files
committed
doc: add workspace initialization into existing NCS workspace
Provide command line instructions on how to add add-on into existing nRF Connect SDK workspace. Signed-off-by: Eduardo Montoya <eduardo.montoya@nordicsemi.no>
1 parent e66bc7a commit 828b1eb

1 file changed

Lines changed: 74 additions & 8 deletions

File tree

docs/setup.rst

Lines changed: 74 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,85 @@ Follow the `Installing the nRF Connect SDK`_ instructions, with the following ex
3434

3535
.. group-tab:: |nRFVSC|
3636

37-
In the **Get the nRF Connect SDK code** part of the install instructions:
38-
39-
In Step 2, click on :guilabel:`Create a new application`, select :guilabel:`Browse nRF Connect SDK Add-on Index`, then select :guilabel:`Zigbee R23`, and select v\ |addon_version| of the |addon|, which also installs |NCS| v\ |ncs_version|.
37+
In the `Get the nRF Connect SDK code <Installing the nRF Connect SDK_>`_ section, click :guilabel:`Create a new application`.
38+
Select :guilabel:`Browse nRF Connect SDK Add-on Index`, then choose :guilabel:`Zigbee R23`.
39+
Select v\ |addon_version| of the |addon|.
40+
This step also installs nRF Connect SDK v\ |ncs_version|.
4041

4142
.. group-tab:: command line
4243

43-
In the **Get the nRF Connect SDK code** part of the install instructions:
44+
You can initialize workspace in two alternative ways:
45+
46+
**Initialize a new workspace:**
47+
48+
1. In the `Get the nRF Connect SDK code <Installing the nRF Connect SDK_>`_, run the following command to initialize west with |addon| v\ |addon_version|, which also initializes nRF Connect SDK v\ |ncs_version|:
49+
50+
a. Initialize ``ncs`` for the add-on:
51+
52+
.. code-block:: console
53+
54+
west init -m "http://github.com/nrfconnect/ncs-zigbee" --mr v1.2.1
55+
56+
#. Update the nRF Connect SDK modules:
57+
58+
.. code-block:: console
59+
60+
west update
61+
62+
**Include add-on in the existing nRF Connect SDK workspace:**
63+
64+
1. Assuming you have an existing nRF Connect SDK workspace in the :file:`ncs` folder, run the following commands:
65+
66+
a. Navigate to the workspace folder:
67+
68+
.. code-block:: console
69+
70+
cd ncs
71+
72+
#. Clone the add-on repository:
73+
74+
.. code-block:: console
75+
76+
git clone https://github.com/nrfconnect/ncs-zigbee
77+
78+
#. Set manifest path to the add-on directory:
79+
80+
.. code-block:: console
81+
82+
west config manifest.path ncs-zigbee
83+
84+
#. Update the nRF Connect SDK modules:
85+
86+
.. code-block:: console
87+
88+
west update
89+
90+
2. Optionally, run these commands in case you need to go back to work on the nRF Connect SDK without the add-on:
91+
92+
a. Configure the manifest path back to the nRF Connect SDK directory
93+
94+
.. code-block:: console
95+
96+
west config manifest.path nrf
97+
98+
#. Update nRF Connect SDK modules
99+
100+
.. code-block:: console
101+
102+
west update
103+
104+
#. Check the current manifest path with the following command:
105+
106+
.. code-block:: console
44107
45-
In Step 4, use the following command to initialize west with |addon| v\ |addon_version|, which also initializes |NCS| v\ |ncs_version|:
108+
west config manifest.path
46109
47-
.. code-block:: console
110+
The output should be:
48111

49-
west init -m "http://github.com/nrfconnect/ncs-zigbee" --mr v1.2.1
112+
.. code-block:: console
50113
114+
nrf
51115
52-
To create an application, use :ref:`zigbee_template_sample` sample as a starting point.
116+
This means that the current workspace is using the nRF Connect SDK.
117+
118+
To create an application, use :ref:`zigbee_template_sample` sample as a starting point.

0 commit comments

Comments
 (0)