README.md

# MCU-Driver-HAL for Arm platforms

This repository contains the driver implementation for Arm hardware platforms.

## Building

```sh
# Configure
cmake -S . -B build
# Build
cmake --build build -j
```

You may want to add argument to those lines to customize your build. For example the configure
stage accepts:

- `-DCMAKE_BUILD_TYPE=Release` will build you applications optimised for size. See
  [here](./MCU-Driver-HAL/tools/cmake/profiles) for more details.
- `-DCMAKE_VERBOSE_MAKEFILE=ON` will make your build tool more verbose, typically printing the
  command lines invoking the compiler.
- `-DCMAKE_EXPORT_COMPILE_COMMANDS=1` generates a build database that can be used by IDE to provide
  better completion.
- `-DMBED_TOOLCHAIN=ARM` can be defined to use the ARM toolchain instead of the default `GCC_ARM`.

The build stage can be passed a specific target name after a `--` to build only that target or `clean` to remove
the build products (objects and executables). E.g.

```sh
cmake --build build -j -- clean
cmake --build build -j -- foo-bar-hal-example-serial
```