Diff: README.md

Revision:

3:2921ef74950b

Child:

4:50241a871e1d

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Mon Dec 12 19:39:11 2016 +0800
@@ -0,0 +1,100 @@
+
+# Getting started with NuMaker-mbed-ADC0_MQ3 on mbed OS
+ 
+The code works on an mbed OS platform. It uses ADC0 to read sensor
+ 
+Please install [mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
+ 
+## Get the example application!
+
+Ontain the mbed-OS library from Windows command prompt
+
+git clone https://github.com/ARMmbed/mbed-os
+
+
+From the command line of Git Bash, for example:
+ 
+```
+hg clone https://developer.mbed.org/teams/Nuvoton/code/NuMaker-mbed-ADC0_MQ3/
+cd NuMaker-mbed-ADC0_MQ3
+
+```
+
+Make shortcut for mbed-os library under the folder NuMaker-mbed-ADC0_MQ3
+ 
+### Now compile
+ 
+Invoke `mbed compile` specifying the name of your platform and your favorite toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
+ 
+```
+mbed compile -m NUMAKER_PFM_NUC472 -t ARM
+```
+ 
+Your PC may take a few minutes to compile your code. At the end you should get the following result:
+ 
+```
+Link: NuMaker-mbed-ADC0_MQ3
+Elf2Bin: NuMaker-mbed-ADC0_MQ3
++--------------+-------+-------+---------+
+| Module       | .text | .data |    .bss |
++--------------+-------+-------+---------+
+| Misc         | 13333 |    32 | 1061844 |
+| features/net |   162 |    16 |      16 |
+| hal/common   |  2531 |    28 |     148 |
+| hal/targets  |  6713 |   272 |     104 |
+| rtos/rtos    |   110 |     4 |       0 |
+| rtos/rtx     |  6484 |    92 |    8316 |
+| Subtotals    | 29333 |   444 | 1070428 |
++--------------+-------+-------+---------+
+Allocated Heap: unknown
+Allocated Stack: unknown
+Total Static RAM memory (data + bss): 1070872 bytes
+Total RAM memory (data + bss + heap + stack): 1070872 bytes
+Total Flash memory (text + data + misc): 29777 bytes
+Image: .\BUILD\NUMAKER_PFM_NUC472\ARM\NuMaker-mbed-ADC0_MQ3.bin
+
+```
+ 
+### Program your board
+ 
+1. Connect your mbed device to the computer over USB.
+1. Copy the binary file to the mbed device .
+1. Press the reset button to start the program.
+ 
+Please refer to the documents at the path https://github.com/OpenNuvoton/NuMaker_NuWicam_Samples/
+ 
+## Export the project to Keil MDK and debug your application
+ 
+From the command line, run the following command:
+ 
+```
+mbed export -m NUMAKER_PFM_NUC472 -i uvision
+```
+ 
+To debug the application:
+ 
+1. Start uVision.
+1. Import the uVision project generated earlier.
+1. Compile your application and generate an `.axf` file.
+1. Make sure uVision is configured to debug over CMSIS-DAP (From the Project menu > Options for Target '...' > Debug tab > Use CMSIS-DAP Debugger).
+1. Set breakpoints and start a debug session.
+ 
+![Image of uVision](img/uvision.png)
+ 
+## Troubleshooting
+ 
+1. Make sure `mbed-cli` is working correctly and its version is greater than `0.8.9`
+ 
+ ```
+ mbed --version
+ ```
+ 
+ If not, you can update it easily:
+ 
+ ```
+ pip install mbed-cli --upgrade
+ ```
+ 
+2. If using Keil MDK, make sure you have a license installed. [MDK-Lite](http://www.keil.com/arm/mdk.asp) has a 32KB restriction on code size.
+ 
+ 
\ No newline at end of file