diff options
Diffstat (limited to 'mule')
| -rw-r--r-- | mule/README.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/mule/README.md b/mule/README.md index 08ece7f..b269a7c 100644 --- a/mule/README.md +++ b/mule/README.md @@ -1,4 +1,12 @@ -# mule.sh +# Mule + +This directory includes tools for Mule STM32 Companion Controller. + +The following tools are available: +- `mule.sh` script +- OpenOCD configuration file + +## mule.sh `mule.sh` is a helper script to control the on-module companion controller. @@ -9,7 +17,7 @@ Parameters: --disable - keep Cortex M0 in reset --flash [<firmware>] - flash the given firmware -## Dependencies +### Dependencies `mule.sh` requires following Debian packages: @@ -17,7 +25,7 @@ Parameters: apt-get install dfu-util usbutils ``` -# openocd.cfg +## OpenOCD On some modules GPIO based SWD support is available. A config file is provided in the tools directory. |