Skip to content

Commit e80e786

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 e80e786

1 file changed

Lines changed: 71 additions & 4 deletions

File tree

docs/setup.rst

Lines changed: 71 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,80 @@ Follow the `Installing the nRF Connect SDK`_ instructions, with the following ex
4040

4141
.. group-tab:: command line
4242

43-
In the **Get the nRF Connect SDK code** part of the install instructions:
43+
Two alternative approaches for initializing the workspace:
44+
45+
a. **Initialize workspace from scratch**
46+
47+
In the **Get the nRF Connect SDK code** part of the install instructions:
48+
49+
In Step 4, use the following command to initialize west with |addon| v\ |addon_version|, which also initializes |NCS| v\ |ncs_version|:
50+
51+
1. Initialize ncs for the add-on
52+
53+
.. code-block:: console
54+
55+
west init -m "http://github.com/nrfconnect/ncs-zigbee" --mr v1.2.1
56+
57+
#. Update nRF Connect SDK modules
58+
59+
.. code-block:: console
60+
61+
west update
62+
63+
#. **Add add-on into existing nRF Connect SDK workspace**
64+
65+
Assume you have an existing nRF Connect SDK workspace in the ``ncs`` folder. Run the following commands:
66+
67+
1. Navigate to the workspace folder
68+
69+
.. code-block:: console
70+
71+
cd ncs
72+
73+
#. Clone add-on repository
74+
75+
.. code-block:: console
76+
77+
git clone https://github.com/nrfconnect/ncs-zigbee
78+
79+
#. Set manifest path to the add-on directory
80+
81+
.. code-block:: console
82+
83+
west config manifest.path ncs-zigbee
84+
85+
#. Update nRF Connect SDK modules
86+
87+
.. code-block:: console
88+
89+
west update
90+
91+
In case you need to go back to work on the nRF Connect SDK:
92+
93+
1. Configure the manifest path back to the nRF Connect SDK directory
94+
95+
.. code-block:: console
96+
97+
west config manifest.path nrf
98+
99+
#. Update nRF Connect SDK modules
100+
101+
.. code-block:: console
102+
103+
west update
104+
105+
You can always check the current manifest path with the following command:
106+
107+
.. code-block:: console
108+
109+
west config manifest.path
44110
45-
In Step 4, use the following command to initialize west with |addon| v\ |addon_version|, which also initializes |NCS| v\ |ncs_version|:
111+
The output will be something like:
46112

47-
.. code-block:: console
113+
.. code-block:: console
48114
49-
west init -m "http://github.com/nrfconnect/ncs-zigbee" --mr v1.2.1
115+
nrf
50116
117+
This means that the current workspace is using the nRF Connect SDK.
51118

52119
To create an application, use :ref:`zigbee_template_sample` sample as a starting point.

0 commit comments

Comments
 (0)