From 885fae07c6fdcfc3fcc4c34bf49d142a31428fa3 Mon Sep 17 00:00:00 2001
From: Robin Appelman <robin@icewind.nl>
Date: Wed, 2 Sep 2020 11:56:22 +0200
Subject: [PATCH] add note about cargo runner

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

diff --git a/README.md b/README.md
index 37b979b..09a98d3 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,17 @@ espflash [--ram] <path to serial> <path to elf image>
 
 when the `--ram` option is specified, the provided elf image will be loaded into ram and executed without touching the flash.
 
+### As cargo runner
+
+You can also use `espflash` as a cargo runner by setting
+
+```
+[target.'cfg(all(target_arch = "xtensa", target_os = "none"))']
+runner = "espflash --ram /dev/ttyUSB0"
+```
+
+in your `.cargo/config`. Which then allows you to run your project using `xargo run`.
+
 ## License
 
 Licensed under the GNU General Public License Version 2.
\ No newline at end of file