Skip to content

doc: Update README #142

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

Closed
markaj-nordic wants to merge 1 commit into from
Closed

doc: Update README #142

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
58 changes: 9 additions & 49 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,17 @@
# ncs-door-lock-app
NCS manifest repo for the door lock reference application.
# nRF Door Lock and Access Control Add-on

## Getting started

Before getting started, set up the nRF Connect SDK development environment.

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:

- [Update operating system](https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/installation/install_ncs.html#update_operating_system)
- [Install prerequisites](https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/installation/install_ncs.html#install_prerequisites)
- [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)

### Initialization

First, initialize the workspace folder (``door-lock-workspace``) where
the ``ncs-door-lock-app`` and all nRF Connect SDK modules will be cloned.
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.
Copy link
Copy Markdown
Member

@adigie adigie Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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, and Thread - allowing developers to choose the appropriate technology for their specific use case.


Run the following commands:
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.
Copy link
Copy Markdown
Member

@adigie adigie Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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, or both protocols, depending on the specific use case and product requirements.


```shell
# launch nRF Connect toolchain for v3.2.0 release
nrfutil sdk-manager toolchain launch --ncs-version v3.2.0 --shell
```

```shell
# initialize workspace for the ncs-door-lock-app (v0.6.0 release)
west init -m https://github.com/nrfconnect/ncs-door-lock-app --mr v0.6.0 door-lock-workspace
```

```shell
# update nRF Connect SDK modules
cd door-lock-workspace
west update
```

For detailed instructions on building and testing the `ncs-door-lock-app` application, see the technical documentation in the `docs` directory.
To build this documentation locally, follow the steps in the section below.

## Building local documentation

To build the documentation locally, you must complete a minimal setup.
## Getting started

Navigate to the ``docs`` folder, and install Sphinx and other documentation dependencies by running the following command:
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).

```shell
pip install -r requirements.txt
```
## License

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

```shell
make html
```
## Support

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