From af55494db2de99620056f31f5339ab9615a73f2a Mon Sep 17 00:00:00 2001
From: jrvollmer <72111610+jrvollmer@users.noreply.github.com>
Date: Fri, 27 Oct 2023 11:02:24 -0500
Subject: [PATCH] TODO Starter make instructions README.md

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

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.
+<!-- 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