Skip to content

Commit 3b2a81b

Browse files
authored
Updated for release
1 parent a6f1318 commit 3b2a81b

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
# Arduino Core for Nordic Semiconductor nRF5 based boards
22

33
## BSP Installation
4-
5-
### Arduino nRF5x BSP via Board Manager
64

7-
**NOTE:** For now, you need to install this BSP to gain access to the compiler. In the
8-
future, only the Adafruit nRF52 BSP will be required.
5+
There are two methods that you can use to install this BSP. We highly recommend the first option unless you with to participate in active development of this codebase via Github.
6+
7+
### Recommended: Adafruit nRF52 BSP via the Arduino Board Manager
98

109
1. [Download and install the Arduino IDE](https://www.arduino.cc/en/Main/Software) (At least v1.6.12)
1110
2. Start the Arduino IDE
1211
3. Go into Preferences
13-
4. Add ```https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json``` as an "Additional Board Manager URL"
14-
5. Open the Boards Manager from the Tools -> Board menu and install "Nordic Semiconductor nRF5 Boards"
15-
6. Select your nRF5 board from the Tools -> Board menu
12+
4. Add https://www.adafruit.com/package_adafruit_index.json as an 'Additional Board Manager URL'
13+
5. Restart the Arduino IDE
14+
6. Open the Boards Manager from the Tools -> Board menu and install 'Adafruit nRF52 by Adafruit'
15+
7. Once the BSP is installed, select 'Adafruit Bluefruit nRF52 Feather' from the Tools -> Board menu, which will update your system config to use the right compiler and settings for the nRF52.
1616

17-
### Adafruit nRF52 BSP via git (for core development)
17+
### Optional (Core Development): Adafruit nRF52 BSP via git
1818

19-
1. Follow steps from Board Manager section above
20-
2. ```cd <SKETCHBOOK>```, where ```<SKETCHBOOK>``` is your Arduino Sketch folder:
19+
1. ```cd <SKETCHBOOK>```, where ```<SKETCHBOOK>``` is your Arduino Sketch folder:
2120
* OS X: ```~/Documents/Arduino```
2221
* Linux: ```~/Arduino```
2322
* Windows: ```~/Documents/Arduino```
2423
3. Create a folder named ```hardware/Adafruit```, if it does not exist, and change directories to it
2524
4. Clone this repo: `git clone [email protected]:adafruit/Adafruit_nRF52_Arduino.git`
2625
5. Restart the Arduino IDE
26+
6. Once the BSP is installed, select 'Adafruit Bluefruit nRF52 Feather' from the Tools -> Board menu, which will update your system config to use the right compiler and settings for the nRF52.
2727

2828
### Third Party Tools
2929

@@ -68,14 +68,6 @@ on your system and available in the system path:
6868
Download and install the [JLink Software and Documentation Pack](https://www.segger.com/downloads/jlink)
6969
from Segger, which will also install a set of command line tools.
7070

71-
#### pynrfjprog
72-
73-
In order to burn the bootloader with a J-Link, you will need `pynrfjprog` from Nordic:
74-
75-
```
76-
$ sudo pip install pynrfjprog
77-
```
78-
7971
### Burning the Bootloader
8072

8173
Once the tools above have been installed and added to your system path, from the Arduino IDE:
@@ -139,10 +131,9 @@ but enter the `MSDEnable` command.
139131

140132
## Credits
141133

142-
This core is based on the [Arduino SAMD Core](https://github.com/arduino/ArduinoCore-samd)
143-
and licensed under the same [GPL License](LICENSE)
134+
This core is based on [Arduino-nRF5](https://github.com/sandeepmistry/arduino-nRF5) by Sandeep Mistry,
135+
which in turn is based on the [Arduino SAMD Core](https://github.com/arduino/ArduinoCore-samd).
144136

145137
The following tools are used:
146138

147139
* [GCC ARM Embedded](https://launchpad.net/gcc-arm-embedded) as the compiler
148-
* A [forked](https://github.com/sandeepmistry/openocd-code-nrf5) version of [OpenOCD](http://openocd.org) to flash sketches

0 commit comments

Comments
 (0)