Skip to content

Commit d2977b1

Browse files
committed
update readme doc
1 parent 0cb582d commit d2977b1

File tree

1 file changed

+23
-28
lines changed

1 file changed

+23
-28
lines changed

README.md

+23-28
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,17 @@
22

33
[![Build Status](https://github.com/adafruit/Adafruit_nRF52_Bootloader/workflows/Build/badge.svg)](https://github.com/adafruit/Adafruit_nRF52_Bootloader/actions)
44

5-
This is a CDC/DFU/UF2 bootloader for nRF52 boards.
5+
A CDC/DFU/UF2 bootloader for Nordic nRF52 microcontroller. UF2 is an easy-to-use bootloader that appears as a flash drive. You can just copy `.uf2`-format application images to the flash drive to load new firmware. See https://github.com/Microsoft/uf2 for more information.
6+
7+
DFU via serial/CDC requires [adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil), a modified version of [Nordic nrfutil](https://github.com/NordicSemiconductor/pc-nrfutil). Install `python3` if it is not installed already and run this command to install adafruit-nrfutil from PyPi:
8+
9+
```
10+
$ pip3 install --user adafruit-nrfutil
11+
```
12+
13+
## Supported Boards
14+
15+
Officially supported boards are:
616

717
- [Adafruit CLUE](https://www.adafruit.com/product/4500)
818
- [Adafruit Circuit Playground Bluefruit](https://www.adafruit.com/product/4333)
@@ -12,34 +22,9 @@ This is a CDC/DFU/UF2 bootloader for nRF52 boards.
1222
- [Adafruit ItsyBitsy nRF52840 Express](https://www.adafruit.com/product/4481)
1323
- [Adafruit LED Glasses Driver nRF52840](https://www.adafruit.com/product/5217)
1424
- Adafruit Metro nRF52840 Express
15-
- [Akizukidenshi AE-BL652-BO](https://akizukidenshi.com/catalog/g/gK-15567/)
16-
- [Electronut Labs Papyr](https://docs.electronut.in/papyr/)
17-
- [iLabs Challenger 840 BLE](https://ilabs.se/challenger-840-ble-datasheet/)
18-
- [MakerDiary MDK nRF52840 USB Dongle](https://makerdiary.com/products/nrf52840-mdk-usb-dongle)
19-
- [MakerDiary nRF52840 M.2 Module](https://makerdiary.com/products/nrf52840-m2-module)
20-
- [Nordic nRF52840DK PCA10056](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK)
21-
- [Nordic nRF52840DK PCA10059 ("Dongle")](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle)
22-
- Particle Argon
23-
- Particle Boron
24-
- Particle Xenon
25-
- [SparkFun MicroMod nRF52840](https://www.sparkfun.com/products/16984)
25+
- [Raytac MDBT50Q-RX Dongle](https://www.adafruit.com/product/5199)
2626

27-
UF2 is an easy-to-use bootloader that appears as a flash drive. You can just copy `.uf2`-format
28-
application images to the flash drive to load new firmware. See https://github.com/Microsoft/uf2 and https://github.com/adafruit/uf2-samdx1 for more information.
29-
30-
[adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil), a modified version of [Nordic nrfutil](https://github.com/NordicSemiconductor/pc-nrfutil), is required to perform DFU. Install `python3` if it is not installed already and run this command to install adafruit-nrfutil from PyPi:
31-
32-
```
33-
$ pip3 install --user adafruit-nrfutil
34-
```
35-
36-
Clone this repo with following commands, or fork it for your own development
37-
38-
```
39-
git clone https://github.com/adafruit/Adafruit_nRF52_Bootloader
40-
cd Adafruit_nRF52_Bootloader
41-
git submodule update --init
42-
```
27+
In addition, there is also lots of other 3rd-party boards which are added by other makers, users and community. Check out the [complete list of all boards here](/src/boards).
4328

4429
## Features
4530

@@ -129,6 +114,16 @@ You must have have a J-Link available to "unbrick" your device.
129114
130115
### Build:
131116
117+
Firstly clone this repo with following commands
118+
119+
```
120+
git clone https://github.com/adafruit/Adafruit_nRF52_Bootloader
121+
cd Adafruit_nRF52_Bootloader
122+
git submodule update --init
123+
```
124+
125+
Then build it with `make BOARD={board} all`, for example:
126+
132127
```
133128
make BOARD=feather_nrf52840_express all
134129
```

0 commit comments

Comments
 (0)