From cd734002c302948f7881c5b0b6cc885620e8a130 Mon Sep 17 00:00:00 2001
From: "Jonathan Pallant (Ferrous Systems)"
 <jonathan.pallant@ferrous-systems.com>
Date: Thu, 1 Feb 2024 19:08:16 +0000
Subject: [PATCH] Update README

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

diff --git a/README.md b/README.md
index 5320ca4..c3bb735 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,25 @@
 
 This repository shows how to compile a Rust application which runs on FreeRTOS.
 
+* `freertos-kernel` is a git submodule to the FreeRTOS github repo
+* `freertos-sys` is a Rust library which runs bindgen on the FreeRTOS headers, and compiles the FreeRTOS source for Cortex-M4F
+* `demo-app` is a Rust application which uses `freertos-sys`, which runs on the nRF52840DK
+
+```console
+$ git submodule update --init
+$ cd demo-app
+$ cargo run --release
+   Compiling freertos-sys v0.1.0 (/Users/jonathan/Documents/ferrous-systems/freertos-experiments/freertos-sys)
+   Compiling demo-app v0.0.0 (/Users/jonathan/Documents/ferrous-systems/freertos-experiments/demo-app)
+    Finished release [optimized + debuginfo] target(s) in 2.43s
+     Running `probe-rs run --chip nRF52840_xxAA target/thumbv7em-none-eabihf/release/demo-app`
+      Erasing ✔ [00:00:00] [###############################################] 12.00 KiB/12.00 KiB @ 32.70 KiB/s (eta 0s )
+  Programming ✔ [00:00:00] [###############################################] 12.00 KiB/12.00 KiB @ 42.13 KiB/s (eta 0s )    Finished in 0.672s
+Hello, this is version unknown!
+Entering FreeRTOS kernel...
+I am the test task! params = 0x0
+```
+
 ## Licence
 
 * Copyright (c) 2024 Ferrous Systems