diff --git a/README.md b/README.md index 61e68a7..33ff2ce 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # Adafruit nRF52840 Bootloader -This repository contains the USB bootloader for Adafruit nRF52840 boards (1MB flash, 256KB SRAM). -This repository depend on the [tinyusb](https://github.com/hathach/tinyusb/tree/develop) as submodule, after cloing this repo you need to run this command +This repository contains the USB bootloader for Adafruit nRF52840 boards (1MB +flash, 256KB SRAM). This repository depend on [tinyusb](https://github.com/hathach/tinyusb/tree/develop) as submodule. After +cloning this repo you need to run the following command: git submodule update --init ## Option 1: Build with makefile -Navigate to `src/singlebank` (recommended) or `src/dualbank` (work in progress), and use feather52840 target for building bootloader. +Navigate to `src/singlebank` (recommended) or `src/dualbank` (work in progress), +and use feather52840 target for building bootloader. make feather52840 @@ -23,16 +25,14 @@ To only flash S140 #### 1. `arm-none-eabi-gcc`: No such file or directory -If you get the following error: +If you get the following error ... -``` -$ make feather52840 -Compiling file: dfu_single_bank.c -/bin/sh: /usr/bin/arm-none-eabi-gcc: No such file or directory -make: *** [_build/dfu_single_bank.o] Error 127 -``` + $ make feather52840 + Compiling file: dfu_single_bank.c + /bin/sh: /usr/bin/arm-none-eabi-gcc: No such file or directory + make: *** [_build/dfu_single_bank.o] Error 127 -You make need to edit the `Makefile` (for example `src/singlebank/Makefile`), +... you may need to edit the `Makefile` (for example `src/singlebank/Makefile`), and update the `GNU_INSTALL_ROOT` to point to the root path of your GCC ARM toolchain. @@ -55,4 +55,9 @@ $ export PATH=$PATH:/Users/Kevin/Downloads/nRF5x-Command-Line-Tools_9_7_2_OSX/nr ## Option 2: Build using Segger Embeded Studio -For better debugging you can also use SES, The project file is located at `src/segger/nrf52840_bootloader.emProject`. Note: the SES only flash the bootloader when you click download, you need to flash Softdevice beforehand if you haven't done so ( use `make flash_sd` mentioned above ) +For better debugging you can also use [SES](https://www.segger.com/products/development-tools/embedded-studio/). +The project file is located at `src/segger/nrf52840_bootloader.emProject`. + +> **Note**: SES only flashes the bootloader when you click download, you need to +flash Softdevice beforehand if you haven't done so ( use `make flash_sd` +mentioned above )