diff --git a/README.md b/README.md index daa45a1..330d7ba 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,27 @@ # embedded-mbed Firmware repository for mbed-based driver and device code. + + + +## Creating a Test + + +## Usage +This project can be compiled and optionally flashed using the following `make` targets: + +Compile the project: +``` +make compile [OPTIONS] +``` + +Compile and flash the project: +``` +make flash MOUNTPOINT= [OPTIONS] +``` +With the following available `OPTIONS` (see the corresponding linked Arm Mbed OS documentation for more information): +- [`PROFILE`](https://os.mbed.com/docs/mbed-os/v6.16/program-setup/build-profiles-and-rules.html): `develop` (default), `debug`, or `release` +- [`TOOLCHAIN`](https://os.mbed.com/docs/mbed-os/v6.16/build-tools/index.html): `GCC_ARM` (default) or `GCC` +- ## Configuration File Structures