Skip to content

Commit

Permalink
TODO Starter make instructions README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jrvollmer committed Oct 28, 2023
1 parent 3682697 commit af55494
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# embedded-mbed
Firmware repository for mbed-based driver and device code.
<!-- TODO Table of contents -->


## Creating a Test
<!-- TODO Fill this in or wait until implementing a new test interface for others to implement -->

## 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=</path/to/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`
- <!-- TODO -->

## Configuration File Structures

Expand Down

0 comments on commit af55494

Please sign in to comment.