From 084632749eb13746897f486a1992eaae11a02af1 Mon Sep 17 00:00:00 2001 From: Eric Callahan Date: Fri, 3 Jun 2022 17:04:22 -0400 Subject: [PATCH] readme: update documentation to include lpc devices Signed-off-by: Eric Callahan --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5a3206f..43d5095 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ # CanBoot - Bootloader for STM32F0/1 MCUs + Bootloader for ARM Cortex-M MCUs - This bootloader is designed for CAN nodes to be used with + This bootloader was initially designed for CAN nodes to be used with [Klipper](https://github.com/Klipper3d/klipper). The bootloader itself makes use of Klipper's hardware abstraction layer, stripped - down to keep the footprint minimal. Currently the bootloader - reserves 8 KiB of space. + down to keep the footprint minimal. In addition to CAN, CanBoot now + supports USB and UART interfaces. -In addition to CANBUS, CanBoot now supports USB and UART interfaces. +Currently lpc176x and stm32 MCUs are supported. CAN support is currently +limited to stm32 F-series devices. -Currently STM32F103, STM32F042, and STM32F072 boards are supported. +CanBoot is licensed under the [GNU GPL v3](/LICENSE). ## Building @@ -23,8 +24,8 @@ make ``` The menuconfig will present the following options: -- `Processor model`: Currently STM32F042, STMF072, and STM32F103 models are - supported. +- `Microcontroller Architecture`: Choose between lpc176x and ST +- `Processor model`: Options depend on the chosen architecture - `Disable SWD at startup`: This is an option for GigaDevice STM32F103 clones. Note that this is untested for the bootloader, GigaDevice clones may not work as expected.