Skip to content

Commit b0ae70b

Browse files
trantanencarlescufi
authored andcommitted
doc: Add workspace initialization into existing NCS workspace
Adding instructions for initializing workspace into an existing NCS workspace. Signed-off-by: Tommi Rantanen <tommi.rantanen@nordicsemi.no>
1 parent beec263 commit b0ae70b

1 file changed

Lines changed: 26 additions & 7 deletions

File tree

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,34 @@ Follow the official
5656

5757
### Initialization
5858

59-
The first step is to initialize the workspace folder (``my-workspace``) where
60-
the ``ncs-example-application`` and all nRF Connect SDK modules will be cloned. Run the following
61-
command:
59+
This section represents alternative approaches for initializing the workspace.
60+
61+
#### Initialize workspace from scratch
62+
63+
The first step is to initialize the workspace folder (``ncs``) where
64+
the ``ncs-example-application`` and all nRF Connect SDK modules will be cloned.
65+
Run the following commands:
66+
67+
```shell
68+
# Initialize ncs for the ncs-example-application (main branch)
69+
west init -m https://github.com/nrfconnect/ncs-example-application --mr main ncs
70+
# Update nRF Connect SDK modules
71+
cd ncs
72+
west update
73+
```
74+
75+
#### Add application into existing nRF Connect SDK workspace
76+
77+
Assume you have an existing nRF Connect SDK workspace in the ``ncs`` folder. Run the following commands:
6278

6379
```shell
64-
# initialize my-workspace for the ncs-example-application (main branch)
65-
west init -m https://github.com/nrfconnect/ncs-example-application --mr main my-workspace
66-
# update nRF Connect SDK modules
67-
cd my-workspace
80+
# Navigate to the workspace folder
81+
cd ncs
82+
# Clone application repository
83+
git clone https://github.com/nrfconnect/ncs-example-application
84+
# Set manifest path to the application directory
85+
west config manifest.path ncs-example-application
86+
# Update nRF Connect SDK modules
6887
west update
6988
```
7089

0 commit comments

Comments
 (0)