Skip to content

Commit 7426ec8

Browse files
committed
doc: Update README
- Updated README file to match the add-on name Signed-off-by: Marcin Kajor <marcin.kajor@nordicsemi.no>
1 parent eb223c3 commit 7426ec8

1 file changed

Lines changed: 9 additions & 49 deletions

File tree

README.md

Lines changed: 9 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,17 @@
1-
# ncs-door-lock-app
2-
NCS manifest repo for the door lock reference application.
1+
# nRF Door Lock and Access Control Add-on
32

4-
## Getting started
5-
6-
Before getting started, set up the nRF Connect SDK development environment.
7-
8-
Follow the official [Installing the nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/installation/install_ncs.html) guide and complete the following steps:
9-
10-
- [Update operating system](https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/installation/install_ncs.html#update_operating_system)
11-
- [Install prerequisites](https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/installation/install_ncs.html#install_prerequisites)
12-
- [Install the nRF Connect SDK toolchain](https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/installation/install_ncs.html#install_the_nrf_connect_sdk_toolchain)
13-
14-
### Initialization
15-
16-
First, initialize the workspace folder (``door-lock-workspace``) where
17-
the ``ncs-door-lock-app`` and all nRF Connect SDK modules will be cloned.
3+
In combination with the nRF Connect SDK, the nRF Door Lock and Access Control Add-on provides a complete reference for building Aliro- and Matter-compatible locks and access control readers for both residential and commercial applications. The reference integrates multiple wireless technologies - including Bluetooth Low Energy (BLE), Ultra-Wideband (UWB), NFC, Thread, and Wi-Fi - allowing developers to choose the appropriate technology for their specific use case.
184

19-
Run the following commands:
5+
Aliro standardizes the interaction that lets a phone or wearable act as a digital key at an opening. Matter specifies how connected products communicate for command-and-control use cases like remotely locking or unlocking a door, checking lock status, user provisioning or integrating with home automation systems. The reference can support Aliro alone, Matter alone, or both protocols, depending on the specific use case and product requirements.
206

21-
```shell
22-
# launch nRF Connect toolchain for v3.2.0 release
23-
nrfutil sdk-manager toolchain launch --ncs-version v3.2.0 --shell
24-
```
25-
26-
```shell
27-
# initialize workspace for the ncs-door-lock-app (v0.6.0 release)
28-
west init -m https://github.com/nrfconnect/ncs-door-lock-app --mr v0.6.0 door-lock-workspace
29-
```
30-
31-
```shell
32-
# update nRF Connect SDK modules
33-
cd door-lock-workspace
34-
west update
35-
```
36-
37-
For detailed instructions on building and testing the `ncs-door-lock-app` application, see the technical documentation in the `docs` directory.
38-
To build this documentation locally, follow the steps in the section below.
39-
40-
## Building local documentation
41-
42-
To build the documentation locally, you must complete a minimal setup.
7+
## Getting started
438

44-
Navigate to the ``docs`` folder, and install Sphinx and other documentation dependencies by running the following command:
9+
To get started with the nRF Door Lock and Access Control Add-on, follow the [documentation](https://docs.nordicsemi.com/bundle/aliro_1.0.0/page/index.html).
4510

46-
```shell
47-
pip install -r requirements.txt
48-
```
11+
## License
4912

50-
Once successfully installed, you can build the Sphinx documentation from the ``docs`` folder:
13+
Source code included within this repository is licensed under the [LicenseRef-Nordic-5-Clause](LICENSE).
5114

52-
```shell
53-
make html
54-
```
15+
## Support
5516

56-
The documentation will be generated in the ``build`` folder.
57-
To view the built documentation, open ``docs/build/html/index.html`` in your web browser.
17+
To ask questions about the reference or to get technical support, please refer to [Nordic DevZone](https://devzone.nordicsemi.com).

0 commit comments

Comments
 (0)