Skip to content

Commit

Permalink
Merge pull request #193 from NordicSemiconductor/doc_update_readme
Browse files Browse the repository at this point in the history
doc: update readme
  • Loading branch information
boundlesscalm authored Apr 12, 2024
2 parents 7d3d7f4 + 20537b6 commit 0aa706b
Showing 1 changed file with 23 additions and 9 deletions.
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
# nRF Connect Boilerplate
# nRF Connect Quick Start

[![Build Status](https://dev.azure.com/NordicSemiconductor/Wayland/_apis/build/status/pc-nrfconnect-boilerplate?branchName=master)](https://dev.azure.com/NordicSemiconductor/Wayland/_build/latest?definitionId=10&branchName=master)
[![Build Status](https://dev.azure.com/NordicSemiconductor/Wayland/_apis/build/status/pc-nrfconnect-quickstart?branchName=master)](https://dev.azure.com/NordicSemiconductor/Wayland/_build/latest?definitionId=10&branchName=master)
[![License](https://img.shields.io/badge/license-Modified%20BSD%20License-blue.svg)](LICENSE)

_nRF Connect Boilerplate_ provides a starting point for developing apps that can
be launched by
[nRF Connect for Desktop](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher).
nRF Connect Quick Start is a cross-platform tool for guided setup and
installation procedures of Nordic Semiconductor devices.

## Installation

nRF Connect Quick Start is installed from nRF Connect from Desktop. For detailed
steps, see
[Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html)
in the nRF Connect from Desktop documentation.

After installing and opening the app from nRF Connect for Desktop, connect your
device to your machine using an USB cable and follow the steps in the
application.

## Documentation

nRF Connect Quick Start is meant as an onboarding tool and it does not come with
its own documentation. The onboarding steps will be different for each of the
[supported devices](https://docs.nordicsemi.com/bundle/nrf-connect-quickstart/page/index.html).

## Development

See the
[app development](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/)
pages for details on how to develop apps for the nRF Connect for Desktop
framework and specifically the description
[how to create a new app project](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/create_new_app),
to understand how you may use this project.
framework.

## Feedback

Expand All @@ -23,7 +37,7 @@ Please report issues on the [DevZone](https://devzone.nordicsemi.com) portal.
## Contributing

See the
[infos on contributing](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/contributing)
[information on contributing](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/contributing)
for details.

## License
Expand Down

0 comments on commit 0aa706b

Please sign in to comment.