From b2c4dd585bf34282d9f16a95fbb7769d6107632b Mon Sep 17 00:00:00 2001
From: 9names <60134748+9names@users.noreply.github.com>
Date: Sun, 1 Aug 2021 23:31:47 +1000
Subject: [PATCH] Add updated README

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 38 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index d3c3f87..b41927b 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,51 @@
-# Raspberry pico RP2040 rust test!
+# App template for rp2040-hal with knurling-rs tooling
+
+This template is intended as a starting point for developing your own firmware based on the rp2040-hal.
+
+It includes all of the `knurling-rs` tooling as showcased in https://github.com/knurling-rs/app-template (`defmt`, `defmt-rtt`, `panic-probe`, `flip-link`) to make development as easy as possible.
+
+`probe-run-rp` is configured as the default runner, so you can start your program as easy as
+```
+cargo run --release
+```
 
 ## Requirements
+- The standard Rust tooling (cargo, rustup) which you can install from https://rustup.rs/
+
+
+- Toolchain support for the cortex-m0+ processors in the rp2040 (thumbv6m-none-eabi)
+
+- flip-link - this allows you to detect stack-overflows
+
+- probe-run. Upstream support for RP2040 is not finished yet, so this template uses `probe-run-rp` for now.
+  `probe-run-rp` is a version of `probe-run` using a `probe-rs` fork with support for the RP2040 chip.
+  Note that this installs the binary with name `probe-run-rp`, so you can still have the original `probe-run` installed in parallel.
+
+  This is important because `probe-run-rp` ONLY works with the RP2040 chip.
 
-- Recent nightly Rust
-- `probe-run-rp` installed.
 - A CMSIS-DAP probe. (JLink probes sort of work but are very unstable. Other probes won't work at all)
 
-`probe-run-rp` is a version of `probe-run` using a `probe-rs` fork with support for the RP2040 chip. To install it use the following command.
+  You can use a second Pico as a CMSIS-DAP debug probe by installing the following firmware on it:
+  https://github.com/majbthrd/DapperMime/releases/download/20210225/raspberry_pi_pico-DapperMime.uf2
 
-    cargo install --git https://github.com/rp-rs/probe-run --branch main
-
-Note that this installs the binary with name `probe-run-rp`, so you can still have the original `probe-run` installed in parallel. This is important because `probe-run-rp` ONLY works with the RP2040 chip.
 
+## Installation of development dependencies
+```
+rustup target install thumbv6m-none-eabi
+cargo install --git https://github.com/rp-rs/probe-run --branch main
+cargo install flip-link
+```
 
 ## Running
 
-Just do `cargo run` :)
+For a debug build
+```
+cargo run
+```
+For a release build
+```
+cargo run --release
+```
   
 ## License