Revision 2:78445cb0f9d7, committed 2017-03-24

Comitter:

mbed_official

Date:

Fri Mar 24 10:30:30 2017 +0000

Parent:

1:8726c6106a06

Commit message:

Merge pull request #6 from 0xc0170/dev_fix_docs

Readme: add specific binary name a user should use
.
Commit copied from https://github.com/ARMmbed/mbed-os-example-bootloader-blinky

Changed in this revision

--- a/README.md	Tue Mar 14 18:15:28 2017 +0000
+++ b/README.md	Fri Mar 24 10:30:30 2017 +0000
@@ -2,6 +2,8 @@
 
 This example shows how to build and use an application with a prebuilt bootloader. For steps on how to create the bootloader, see [mbed-os-example-bootloader](https://github.com/ARMmbed/mbed-os-example-bootloader).
 
+To read more about the bootloader, please visit [bootloader tutorial](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/advanced/bootloader/).
+
 ## Required hardware
 * A supported board - [u-blox EVK-ODIN-W2](https://developer.mbed.org/platforms/ublox-EVK-ODIN-W2/), [Nucleo F429ZI](https://developer.mbed.org/platforms/ST-Nucleo-F429ZI/) or [K64F](https://developer.mbed.org/platforms/FRDM-K64F/).
 * CI test shield.
@@ -23,14 +25,14 @@
 To either use a different board or a different SD card slot, you must rebuild the bootloader and update the application.
 To do this:
 
-1. Create a bootloader for your board in the project [mbed-os-example-bootloader](https://github.com/ARMmbed/mbed-os-example-bootloader).
-2. Update your board to use the newly created booloader image. To do this, set the target value `bootloader_img` to the file path of the bootloader image.
+1. Create a bootloader for your board in the project [mbed-os-example-bootloader](https://github.com/ARMmbed/mbed-os-example-bootloader). The bootloader image is named ``mbed-os-example-bootloader.bin``.
+2. Update your board to use the newly created bootloader image. To do this, set the target (replace ``<TARGET_NAME>`` with your target name) value `bootloader_img` to the file path of the bootloader image.
 
 ```
     "target_overrides": {
         ...
-        "NUCLEO_F429ZI": {
-            "target.bootloader_img": "bootloader/NUCLEO_F429ZI.bin"
+        "<TARGET_NAME>": {
+            "target.bootloader_img": "bootloader/<TARGET_NAME>.bin"
         },
         ...
 ```
@@ -40,15 +42,15 @@
 Invoke `mbed compile`, and specify the name of your platform and your favorite toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
 
 ```
-mbed compile -m NUCLEO_F429ZI -t ARM
+mbed compile -m <TARGET_NAME> -t ARM
 ```
 
 Your PC may take a few minutes to compile your code. At the end, you see the following result:
 
 ```
 Merging Regions:
-  Filling region bootloader with bootloader/NUCLEO_F429ZI.bin
-  Filling region application with .\BUILD\NUCLEO_F429ZI\GCC_ARM\mbed-os-example-bootloader-blinky_application.bin
+  Filling region bootloader with bootloader/<TARGET_NAME>.bin
+  Filling region application with .\BUILD\<TARGET_NAME>\GCC_ARM\mbed-os-example-bootloader-blinky_application.bin
 Space used after regions merged: 0x296f4
 +-----------------------+-------+-------+-------+
 | Module                | .text | .data |  .bss |
@@ -76,7 +78,7 @@
 ## Program bootloader and application
 
 1. Connect your mbed device to the computer over USB.
-1. Copy the binary file to the mbed device.
+1. Copy the mbed-os-example-bootloader-blinky binary file to the mbed device.
 1. Press the reset button to start the program.
 
 The LED on your platform turns on and off.