Skip to content

Commit 4a7905c

Browse files
divipillaibjda
authored andcommitted
doc: Updates to index and readme pages
Updates to index and readme pages Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent 4ee8509 commit 4a7905c

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,17 @@ Alternatively, you can download pre-built firmware binaries from the latest rele
5050

5151
## Setting up the development environment
5252

53-
To build the firmware from source, you need the nRF Connect SDK development environment ([setup guide](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/installation.html)). There are two options for setting up and building the project. For a detailed walkthrough, see the [Getting Started Guide](docs/common/getting_started.md).
53+
There are two options for setting up and building the project.
5454

5555
### Option 1: nRF Connect for VS Code (Recommended)
5656

5757
Use the [nRF Connect for VS Code](https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/index.html) extension for an integrated development experience:
5858

59-
1. Open VS Code and go to the **nRF Connect** extension.
60-
2. Select **Create New Application****Browse nRF Connect SDK add-on Index**.
61-
3. Search for **Asset Tracker Template** and create the project.
62-
4. Use the **Actions** panel in the extension to build and flash the application.
63-
64-
For more details, see the [Getting Started Guide](docs/common/getting_started.md).
59+
1. To install the nRF Connect SDK and its toolchain using nRF Connect for VS Code, follow [extension documentation](https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/get_started/quick_setup.html) or [Installing nRF Connect SDK and VS Code exercise] (https://academy.nordicsemi.com/courses/nrf-connect-sdk-fundamentals/lessons/lesson-1-nrf-connect-sdk-introduction/topic/exercise-1-1/) on Nordic Developer Academy.
60+
2. Open VS Code and go to the **nRF Connect** extension.
61+
3. Select **Create New Application****Browse nRF Connect SDK add-on Index**.
62+
4. Search for **Asset Tracker Template** and create the project.
63+
5. Use the **Actions** panel in the extension to build and flash the application.
6564

6665
### Option 2: Command line
6766

@@ -88,7 +87,7 @@ For more details, see the [Getting Started Guide](docs/common/getting_started.md
8887
nrfutil sdk-manager toolchain launch --ncs-version v3.1.0 --terminal
8988
```
9089

91-
This will launch a new terminal window with the specified toolchain activated, use this terminal in the coming steps.
90+
This launches a new terminal window with the specified toolchain activated. Use this terminal in the coming steps.
9291

9392
5. Initialize workspace:
9493

@@ -117,6 +116,8 @@ west flash --erase
117116
```
118117
</details>
119118

119+
For more details, see the [Getting Started Guide](docs/common/getting_started.md).
120+
120121
### Provision device to nRF Cloud
121122

122123
After building and flashing (using either option above), you need to provision the device to connect to [nRF Cloud](https://nrfcloud.com).

docs/index.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ The Asset Tracker Template is a modular framework for developing IoT application
44

55
The system is organized into modules, each responsible for a specific functionality, such as managing network connectivity, handling cloud communication, or collecting environmental data. Modules communicate through [zbus](https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/services/zbus/index.html) channels, ensuring loose coupling and maintainability.
66

7-
The Asset Tracker Template is an add-on and released separately from the [Asset-Tracker-Template](https://github.com/nrfconnect/Asset-Tracker-Template) repository.
8-
97
**Supported hardware**:
108

119
* [Thingy:91 X](https://www.nordicsemi.com/Products/Development-hardware/Nordic-Thingy-91-X)
@@ -21,18 +19,17 @@ Alternatively, you can download pre-built firmware binaries from the latest rele
2119

2220
## Setting up the development environment
2321

24-
To build the firmware from source, you need the nRF Connect SDK development environment ([setup guide](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/installation.html)). There are two options for setting up and building the project. For a detailed walkthrough, see the [Getting Started Guide](common/getting_started.md).
22+
There are two options for setting up and building the project.
2523

2624
### Option 1: nRF Connect for VS Code (Recommended)
2725

2826
Use the [nRF Connect for VS Code](https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/index.html) extension for an integrated development experience:
2927

30-
1. Open VS Code and go to the **nRF Connect** extension.
31-
2. Select **Create New Application****Browse nRF Connect SDK add-on Index**.
32-
3. Search for **Asset Tracker Template** and create the project.
33-
4. Use the **Actions** panel in the extension to build and flash the application.
34-
35-
For more details, see the [Getting Started Guide](common/getting_started.md).
28+
1. To install the nRF Connect SDK and its toolchain using nRF Connect for VS Code, follow [extension documentation](https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/get_started/quick_setup.html) or [Installing nRF Connect SDK and VS Code exercise] (https://academy.nordicsemi.com/courses/nrf-connect-sdk-fundamentals/lessons/lesson-1-nrf-connect-sdk-introduction/topic/exercise-1-1/) on Nordic Developer Academy.
29+
2. Open VS Code and go to the **nRF Connect** extension.
30+
3. Select **Create New Application****Browse nRF Connect SDK add-on Index**.
31+
4. Search for **Asset Tracker Template** and create the project.
32+
5. Use the **Actions** panel in the extension to build and flash the application.
3633

3734
### Option 2: Command line
3835

@@ -48,7 +45,7 @@ For more details, see the [Getting Started Guide](common/getting_started.md).
4845
</li>
4946
<li>Launch toolchain:
5047
<pre><code class="language-bash">nrfutil sdk-manager toolchain launch --ncs-version v3.1.0 --terminal</code></pre>
51-
This will launch a new terminal window with the specified toolchain activated, use this terminal in the coming steps.
48+
This launches a new terminal window with the specified toolchain activated. Use this terminal in the coming steps.
5249
</li>
5350
<li>Initialize workspace
5451
<pre><code class="language-bash">west init -m https://github.com/nrfconnect/Asset-Tracker-Template.git --mr main asset-tracker-template
@@ -78,6 +75,8 @@ west update</code></pre>
7875
```
7976
</details>
8077

78+
For more details, see the [Getting Started Guide](common/getting_started.md).
79+
8180
### Provision device to nRF Cloud
8281

8382
After building and flashing (using either option above), you need to provision the device to connect to [nRF Cloud](https://nrfcloud.com).

0 commit comments

Comments
 (0)