diff options
| author | Daniel Semkowicz <dse@thaumatec.com> | 2023-08-24 07:23:11 +0200 |
|---|---|---|
| committer | Daniel Semkowicz <dse@thaumatec.com> | 2023-08-24 07:23:11 +0200 |
| commit | e5ecc5f220e9bb54386f730910281c16e48e8ff3 (patch) | |
| tree | b00317ef19a6f959690513420438d239da8260fe | |
| parent | d969a0921a10c220e897639bcb1125797b76d12c (diff) | |
mule: README.md: Add introduction section
Describe shortly what can be found in mule directory.
Relates-to: RNG-10
Signed-off-by: Daniel Semkowicz <dse@thaumatec.com>
| -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. |