Skip to content

doc: Add workspace initialization into existing NCS workspace #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trantanen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: Add workspace initialization into existing NCS workspace #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,34 @@ Follow the official

### Initialization

The first step is to initialize the workspace folder (``my-workspace``) where
the ``ncs-example-application`` and all nRF Connect SDK modules will be cloned. Run the following
command:
This section represents alternative approaches for initializing the workspace.

#### Initialize workspace from scratch

The first step is to initialize the workspace folder (``ncs``) where
the ``ncs-example-application`` and all nRF Connect SDK modules will be cloned.
Run the following commands:

```shell
# Initialize ncs for the ncs-example-application (main branch)
west init -m https://github.com/nrfconnect/ncs-example-application --mr main ncs
# Update nRF Connect SDK modules
cd ncs
west update
```

#### Add application into existing nRF Connect SDK workspace

Assume you have an existing nRF Connect SDK workspace in the ``ncs`` folder. Run the following commands:

```shell
# initialize my-workspace for the ncs-example-application (main branch)
west init -m https://github.com/nrfconnect/ncs-example-application --mr main my-workspace
# update nRF Connect SDK modules
cd my-workspace
# Navigate to the workspace folder
cd ncs
# Clone application repository
git clone https://github.com/nrfconnect/ncs-example-application
# Set manifest path to the application directory
west config manifest.path ncs-example-application
# Update nRF Connect SDK modules
west update
```

Expand Down