diff options
| author | Damien <damlobster@gmail.com> | 2021-07-22 00:40:40 +0200 |
|---|---|---|
| committer | KevinOConnor <kevin@koconnor.net> | 2021-07-27 13:15:25 -0400 |
| commit | cff61605fb7260ab60d1abd4e295b71a533869ac (patch) | |
| tree | f117dd64e85ec18a62c7c4305781fa03d37ed0a9 /docs/SDCard_Updates.md | |
| parent | 7e88f9220c641dd1e7e5b748381bd7ac758bc8d2 (diff) | |
| download | kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.gz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.xz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.zip | |
docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top.
Signed-off-by: Damien Martin <damlobster@gmail.com>
Update CNAME
Diffstat (limited to 'docs/SDCard_Updates.md')
| -rw-r--r-- | docs/SDCard_Updates.md | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/docs/SDCard_Updates.md b/docs/SDCard_Updates.md index b7994512..09307715 100644 --- a/docs/SDCard_Updates.md +++ b/docs/SDCard_Updates.md @@ -1,3 +1,5 @@ +# SDCard updates + Many of today's popular controller boards ship with a bootloader capable of updating firmware via SD Card. While this is convenient in many circumstances, these bootloaders typically provide no other way to update @@ -7,8 +9,7 @@ After Klipper has been initially flashed to a controller it is possible to transfer new firmware to the SD Card and initiate the flashing procedure via ssh. -Typical Upgrade Procedure -========================= +## Typical Upgrade Procedure The procedure for updating MCU firmware using the SD Card is similar to that of other methods. Instead of using `make flash` it is necessary to run a @@ -37,8 +38,7 @@ Supported boards can be listed with the following command: If you do not see your board listed it may be necessary to add a new board definition as [described below](#board-definitions). -Advanced Usage -============== +## Advanced Usage The above commands assume that your MCU connects at the default baud rate of 250000 and the firmware is located at `~/klipper/out/klipper.bin`. The @@ -78,8 +78,7 @@ Note that when upgrading a MKS Robin E3 it is not necessary to manually run `update_mks_robin.py` and supply the resulting binary to `flash-sdcard.sh`. This procedure is automated during the upload process. -Caveats -======= +## Caveats - As mentioned in the introduction, this method only works for upgrading firmware. The initial flashing procedure must be done manually per the @@ -92,8 +91,7 @@ Caveats Boards that use SDIO, such as the Flymaker Flyboard and MKS Robin Nano V1/V2, will not work. -Board Definitions -================= +## Board Definitions Most common boards should be available, however it is possible to add a new board definition if necessary. Board definitions are located in |