tools/mpremote: Add some basic documentation.

Signed-off-by: Damien George <damien@micropython.org>
micropython · May 29, 2021 · 0aab860 · 0aab860
1 parent 1405fc2
commit 0aab860
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/tools/mpremote/README.md b/tools/mpremote/README.md
@@ -1,3 +1,13 @@
 # mpremote -- MicroPython remote control
 
 This CLI tool is used to remotely control a MicroPython device or instance.
+
+Any user configuration can be placed in .config/mpremote/config.py.  For
+example:
+
+    # Custom macro commands
+    commands = {
+        "c33": "connect id:334D335C3138",
+        "bl": "bootloader",
+        "double x=4": "eval x*2",
+    }