📝 Improve, clean up READMEs (#988)

config/examples/AnyCubic/i3 Mega/Trigorilla Pro STM32/README.md

@@ -2,7 +2,7 @@
 
 ## Usage
 Use these configurations like any other configs. Set `default_envs = trigorilla_pro` in `platformio.ini` for a simplified build. Flashing with PlatformIO may be broken. If so you can use OctoPrint firmware flasher plugin or the `stm32flash` tool in the terminal, like so:
-```sh
+```shell
 stm32flash -w firmware.bin -v -g 0x0 -b 115200 <YOUR COM/SERIAL PORT HERE>
 ```
 

config/examples/BIQU/Hurakan/README.md

@@ -21,7 +21,8 @@ The Biqu Hurakan ships with a BigTreeTech Manta M4P motherboard which includes a
 
 # Update Hurakan CB1 Image Defaults
 
-⚠️ Start with the latest `CB1_Debian11_Klipper_kernel*.img.xz` (full) image from [bigtreetech/CB1/releases](https://github.com/bigtreetech/CB1/releases). ⚠️
+> [!IMPORTANT]
+> Start with the latest `CB1_Debian11_Klipper_kernel*.img.xz` (full) image from [bigtreetech/CB1/releases](https://github.com/bigtreetech/CB1/releases).
 
 ## SSH into to the CB1
 

config/examples/Creality/Ender-5 Plus/BigTreeTech SKR 3/README.md

@@ -1,9 +1,14 @@
 # Ender-5 Plus with BTT SKR 3 Configurations for Marlin Firmware
 
-## Important
+> [!IMPORTANT]
-
+> LCD cable will need to be modified to fit the SKR 3 motherboard (See board silkscreens for pin labels):
-The LCD will need the cable modified to fit the SKR 3 motherboard.
+>
-Four pins, tx2-pa10 rx2-pa9 gnd-g 5v-+5v, ( See the boards silkscreens for pin labels)
+> |  LCD -> SKR 3   |
+> |-----------------|
+> | `TX2` -> `PA10` |
+> | `RX2` -> `PA9`  |
+> | `GND` -> `G`    |
+> | `5V` -> `+5V`   |
 
 ## About
 

config/examples/Creality/Ender-5 Plus/CrealityV1 (ORIGIN UI)/README.md

@@ -1,8 +1,7 @@
 # Ender-5 Plus Configurations for Marlin Firmware
 
-## Important
+> [!IMPORTANT]
-
+> The Ender-5 LCD stock firmware is only compatible with Creality firmware. The LCD standard UI will not function. This is expected.
-NOTE: The Ender-5 LCD stock firmware is only compatible with Creality firmware. The LCD standard UI will not function. This is expected.
 
 ## Marlin DGUS UI Instructions
 

config/examples/Creality/Ender-5 Plus/CrealityV1 (RELOADED UI)/README.md

@@ -1,8 +1,7 @@
 # Ender-5 Plus Configurations for Marlin Firmware
 
-## Important
+> [!IMPORTANT]
-
+> The Ender-5 LCD stock firmware is only compatible with Creality firmware. The LCD standard UI will not function. This is expected. With the stock LCD firmware Marlin can only be controlled from a host over USB.
-NOTE: The Ender-5 LCD stock firmware is only compatible with Creality firmware. The LCD standard UI will not function. This is expected. With the stock LCD firmware Marlin can only be controlled from a host over USB.
 
 ## Marlin DGUS UI "Reloaded" Instructions
 
@@ -32,4 +31,4 @@ The Ender-5 stock LCD can optionally use a customized Marlin DGUS interface. To
 
 ## Restoring Factory Firmware
 
-The original firmware can be restored by downloading the [Ender 5 Plus firmware](https://www.creality.com/download) from Creality. You can follow the same LCD flashing procedure using the Creality-provided `DWIN_SET` folder.
+The original firmware can be restored by downloading the [Ender 5 Plus firmware](https://www.creality.com/download) from Creality. You can follow the same LCD flashing procedure using the Creality-provided `DWIN_SET` folder.

config/examples/Creality/Ender-5/BigTreeTech SKR Mini E3 2.0/README.md

@@ -1,19 +1,5 @@
 # Ender-5 with BigTreeTech SKR Mini E3 v2.0
 
-## Build with "Auto Build Marlin"
-
-For the best experience building with PlatformIO in VSCode, open up the "Extensions" panel and install the "Auto Build Marlin" extension. After installation, open up the Auto Build Marlin view and click the "Build" button for the "512K" environment.
-
-## Build with PlatformIO
-
-For direct PlatformIO build, locate the `env:STM32F103RC_btt_512K` group the PlatformIO panel and click the "Build" item in that group to start the build.
-
-To make the main "Build" button apply to this board's environment, edit the `platformio.ini` section `[platformio]` and change `default_envs` to
-
-```ini
-default_envs = STM32F103RC_btt_512K
-```
-
 ## Older Leadscrew
 
 > [!NOTE]

config/examples/Elegoo/Neptune 2/README.md

@@ -1,10 +1,12 @@
 ## Elegoo Neptune 2/Neptune 2D/Neptune 2S Configuration
 
-***IMPORTANT:*** The firmware binary file must be named `elegoo.bin` or it will not flash.
+> [!IMPORTANT]
+> The firmware binary file must be named `elegoo.bin` or it will not flash.
 
 The provided configuration includes custom switches at the top of `Configuration.h` to simplify the build options. It supports both the ZNP Robin Nano 1.2 and 1.3 Boards with only minor configuration changes. By default, the configuration applies to the 1.3 board without BLTouch.
 
-NOTE: The original Neptune 2 and 2S use the same configurations, but the 2S always uses the 1.3 version of the board.
+> [!NOTE]
+> The original Neptune 2 and 2S use the same configurations, but the 2S always uses the 1.3 version of the board.
 
 ### ZNP Robin Nano 1.2 boards:
 - `Configuration.h`: Disable `IS_BOARD_1_3`.

config/examples/Felix/DUAL/README.md

@@ -10,7 +10,7 @@ Bringing silky smooth prints to Felix.
     - [Stable version](https://github.com/MarlinFirmware/Marlin/tree/Development)
   - In both cases use the "Download Zip" button on the right.
 
-```
+```shell
 cd Marlin/src
 cp config/examples/Felix/Configuration_adv.h .
 ```

config/examples/Felix/Single/README.md

@@ -10,7 +10,7 @@ Bringing silky smooth prints to Felix.
     - [Stable version](https://github.com/MarlinFirmware/Marlin/tree/Development)
   - In both cases use the "Download Zip" button on the right.
 
-```
+```shell
 cd Marlin/src
 cp config/examples/Felix/Configuration_adv.h .
 ```
@@ -19,11 +19,15 @@ The next step depends on your setup:
 
 ### Single Extruder Configuration
 
-    cp config/examples/Felix/Configuration.h .
+```shell
+cp config/examples/Felix/Configuration.h .
+```
 
 ### Dual Extruder Configuration
 
-    cp config/examples/Felix/DUAL/Configuration.h Configuration.h
+```shell
+cp config/examples/Felix/DUAL/Configuration.h Configuration.h
+```
 
 ### Compile Firmware
 
@@ -43,17 +47,23 @@ The next step depends on your setup:
 
 Find the latest Arduino build:
 
-    ls -altr /tmp/
+```shell
-    drwxr-xr-x 5 chrono users 12288 Mar 3 21:41 build6072035599686630843.tmp
+ls -altr /tmp/
+drwxr-xr-x 5 chrono users 12288 Mar 3 21:41 build6072035599686630843.tmp
+```
 
 Copy the firmware to your printer host:
 
-    scp /tmp/build6072035599686630843.tmp/Marlin.cpp.hex a.b.c.d:/tmp/
+```shell
+scp /tmp/build6072035599686630843.tmp/Marlin.cpp.hex a.b.c.d:/tmp/
+```
 
 Connect to your printer host via ssh, stop Octoprint or any other service that may block your USB device and make sure you have avrdude installed, then run:
 
-    avrdude -C/etc/avrdude.conf -v -v -v -patmega2560 -cwiring -P/dev/ttyUSB0 \
+```shell
-    -b115200 -D -Uflash:w:/tmp/Marlin.cpp.hex:i
+avrdude -C/etc/avrdude.conf -v -v -v -patmega2560 -cwiring -P/dev/ttyUSB0 \
+-b115200 -D -Uflash:w:/tmp/Marlin.cpp.hex:i
+```
 
 ## Acknowledgements
 

config/examples/JGAurora/A5/README.md

@@ -1,29 +1,7 @@
 # Configuration for JGAurora A5 printer
 
-## Firmware Installation Instructions
+> [!IMPORTANT]
-
+> Before flashing your printer, unplug the 8-pin LCD panel header connector. The LCD should turn off completely. This is found underneath the LCD, and can be accessed from underneath the printer without removing any screws. Remember where it goes so you can put it back after flashing.
-To install custom firmware:
-
-- Download and install arduino IDE software from https://www.arduino.cc/en/Main/Software
-- Plug in A5 to your computer via USB cable
-- In arduino IDE, under the Tools menu, set:
-  – **Board** to "Arduino/Genuino Mega or Mega 2560"
-  – ***Processor*** to "Atmega 2560 (Mega 2560)"
-  – **Port** to your 3D printer’s serial port. To figure out the correct serial port unplug the printer and observe the "Port" menu. Connect the printer's USB cable, re-open the "Port" menu and see if a new ports has appeared. This new port is likely to be your printer.
-    - If you can’t find the right port or if your machine isn't detected, you may need to install a driver for the CH340 serial-to-USB interface chip in the printer.
-      - [macOS CH340 Serial Driver](http://sampin.ch/ch340-driver-mac)
-      - [Windows CH340 Serial Driver](https://sparks.gogo.co.nz/ch340.html)
-- Install the u8glib library using the library manager in the menu "Sketch -> Include Library -> Manage Libraries."
-- IMPORTANT: Unplug the 8-pin LCD panel header connector on your printer. The LCD should turn off completely. This is found underneath the LCD, and can be accessed from underneath the printer without removing any screws. Remember where it goes so you can put it back after flashing.
-- Close all other programs (Cura, Repetier Host, JGCreat, etc.) that could connect to the serial port.
-- Open the "Marlin.ino" file in Arduino IDE and wait for the new project window to appear.
-- Select "Upload" from the "Sketch" menu or click the Upload button.
-- Wait for the firmware to finish uploading and verifying. This may take a couple of minutes.
-- Plug the LCD connector back in.
-- In the Arduino IDE, select "Tools -> Serial monitor" to open up a simple console. In the popup menus, select "Newline" and a Baud Rate of "250000."
-- In the input box, enter the following G-code commands:
-  - `M502` (press return) to reset settings (in RAM) to your configured defaults.
-  - `M500` (press return) to write settings and initialize the EEPROM.
 
 ## Graphical Display
 

config/examples/Prusa/MK3S-BigTreeTech-BTT002/README.md

@@ -15,13 +15,15 @@ Flags specific to this printer/configuration:
 - `SUPERPINDA` - SuperPinda present?
 
 ## Upgrade Notes
-* ⚠️ Cut or desolder the Z & E driver DIAG pins or they will interfere with PINDA & filament runout detection. ⚠️
+> [!IMPORTANT]
-* Set the jumpers under your drivers to "TMC2208-UART MODE":
+> * Cut or desolder the Z & E driver DIAG pins or they will interfere with PINDA & filament runout detection.
-
+> * Set the jumpers under your drivers to "TMC2208-UART MODE":
-  <img src="https://user-images.githubusercontent.com/13375512/74117621-24415000-4b6d-11ea-8811-f867e187ea0c.png" width="50%">
+>
+>   <img src="https://user-images.githubusercontent.com/13375512/74117621-24415000-4b6d-11ea-8811-f867e187ea0c.png" width="50%">
 
 ## Changes to Start G-code
-The `W` in Průša's `G28 W ; home all without mesh bed level` default G-code does not exist in Marlin and [`G80 ; mesh bed leveling`](https://marlinfw.org/docs/gcode/G080.html) cancels the current motion mode, so no bed leveling will take place.
+> [!IMPORTANT]
+> The `W` in Průša's `G28 W ; home all without mesh bed level` default G-code does not exist in Marlin and [`G80 ; mesh bed leveling`](https://marlinfw.org/docs/gcode/G080.html) cancels the current motion mode, so no bed leveling will take place.
 
 Below are some example start G-code scripts from popular slicers to get you started.
 

config/examples/Tronxy/X5SA/README.md

@@ -16,7 +16,7 @@
 You can (OR MUST) dump the current settings of your printer. It may help you to figure out some configs, like steps/mm of your extruder.
 
 1. Create a file named `savesettings.gcode` with the following content:
-```
+```gcode
 M6046 ; sdcard access
 M8512 "currentconfig.gcode" ; save settings to file
 ```

config/examples/Velleman/K8200 Upgraded/README.md

@@ -19,17 +19,17 @@ use the original version.
 If you have a VM8204 upgraded Z axis and coupler, ensure the following line
 is uncommented. Otherwise comment it out:
 
-```
+```cpp
 #define K8200_K8204
 ```
 If you have the VM8201 display unit, uncomment the following line
-```
+```cpp
 //#define K8200_VM8201
 ```
 
 If you have the *3D Printer Full Graphic Smart Controller with 3Drag adapter* (or other screen based on the [RepRap Discount Full Graphic Smart Controller](https://reprap.org/wiki/RepRapDiscount_Full_Graphic_Smart_Controller)), ensure
 the following is uncommented, otherwise comment it out
-```
+```cpp
 #define FULLGRAPHIC_CONTROLLER_LCD_SD
 ```
 

config/examples/Velleman/K8400/Single-head/README.md

@@ -6,7 +6,8 @@ Like its predecessor, (K8200), the K8400 is a 3Drag clone. There are some minor
 
 Single and dual head configurations provided. Copy the correct Configuration.h and Configuration_adv.h to the /src/config directory.
 
-**NOTE: This configuration includes the community sourced feed rate fix. Use 100% feed rate in Repetier!**
+> [!NOTE]
+> This configuration includes the community sourced feed rate fix. Use 100% feed rate in Repetier!
 
 For implementation and updated K8400 firmware, see https://github.com/birkett/Velleman-K8400-Firmware
 

config/examples/WASP/PowerWASP/README.md

@@ -50,7 +50,7 @@ The bootloader looks for byte in EEPROM at address 0x3FF:
 
 To generate a bin file you need issue the following command on you apps elf executable:
 
-```
+```shell
 avr-objcopy -I elf32-avr -O binary firmware.cpp.elf firmware.bin
 ```
 
@@ -59,22 +59,22 @@ file in you apps build directory.
 
 ### Using olimex usb to upload bootloader
 
-```
+```shell
 avrdude -c stk500v2 -p m2560 -P /dev/tty.usbmodemfd131 -B 500 -e -u -U lock:w:0x3F:m -U efuse:w:0xFD:m -U hfuse:w:0xD8:m -U efuse:w:0xFF:m -F
 ```
 
-```
+```shell
 avrdude -p m2560 -c stk500v2 -P /dev/tty.usbmodemfa131 -F -U flash:w:stk500boot.hex -b 115200 -B1 -U lock:w:0x0F:m
 ```
 
-```
+```shell
 avrdude -p m168 -c usbtiny -e -u -U lock:w:0x3f:m -U efuse:w:0x00:m -U hfuse:w:0xDD:m -U lfuse:w:0xFF:m
 ```
 
-```
+```shell
 avrdude -p m2560 -c stk500v2 -P /dev/tty.usbmodemfd131 -U flash:w:stk500boot_v2_mega2560.hex -U lock:w:0x0F:m -v
 ```
 
-```
+```shell
 avrdude -c stk500v2 -p m2560 -P /dev/tty.usbmodemfd131 -U lock:w:0x3F:m -U efuse:w:0xFD:m -U hfuse:w:0xD8:m -U lfuse:w:0xFF:m -e -v
 ```

config/examples/delta/Anycubic/Kossel/README.md

@@ -6,7 +6,8 @@ These configurations activate many of the new advanced features of the Marlin fi
  * Auto Bed Leveling
  * Pause & Filament Change
 
-**Important**: Before doing anything else after updating the firmware, go to `Configuration > Advanced Settings > Initialize EEPROM` to get rid of old configurations.
+> [!IMPORTANT]
+> Before doing anything else after updating the firmware, go to `Configuration > Advanced Settings > Initialize EEPROM` to get rid of old configurations.
 
 Then you should execute `Configuration > Delta Calibration > Set Delta Height` and also run `Configuration > Delta Configuration > Probe Z-offset` to verify the Probe offset.
 
@@ -19,7 +20,8 @@ Please do a manual paper test (moving the nozzle slowly down to Z0 and checking
 
 # Select the Configuration
 
-**Please select the correct values at the start of the Configuration.h file**
+> [!IMPORTANT]
+> Please select the correct values at the start of the Configuration.h file
 
 The Kossel comes in 3 versions:
 
@@ -39,7 +41,8 @@ Typically the probes for the Anycubic Delta Kossel printers come in two differen
 
     ![Version 2 Probe](images/Version2Probe.jpg)
 
-If you select the `ANYCUBIC_PROBE_VERSION 0`: It's very important to follow the correct procedure to set it up after flashing the firmware, otherwise you might damage the printer by ramming the nozzle into the buildplate:
+> [!IMPORTANT]
+> If you select the `ANYCUBIC_PROBE_VERSION 0`, it's very important to follow the correct procedure to set it up after flashing the firmware, otherwise you might damage the printer by ramming the nozzle into the buildplate:
 
 * `Configuration > Advanced Settings > Initialize EEPROM`
 * `Motion > Move Axis > Soft Endstops` : `Off`

config/examples/delta/Velleman/K8800/README.md

@@ -56,7 +56,10 @@ Bilinear Leveling uses the same approach as the original firmware, with the adva
 
 ## Unified Bed Leveling and Cura
 
-Unified Bed Leveling is more accurate due to the addition of manual probing, but requires changes to the Cura settings. **AT THIS TIME OF WRITING, THE AS-SHIPPED CURA PROFILE INCLUDES G-CODE COMMANDS THAT ARE INCOMPATIBLE WITH UBL AND IN ONE CASE MAY FORCE A HEAD CRASH DURING PREFLIGHT.**
+Unified Bed Leveling is more accurate due to the addition of manual probing, but requires changes to the Cura settings.
+
+> [!IMPORTANT]
+> AT THIS TIME OF WRITING, THE AS-SHIPPED CURA PROFILE INCLUDES G-CODE COMMANDS THAT ARE INCOMPATIBLE WITH UBL AND IN ONE CASE MAY FORCE A HEAD CRASH DURING PREFLIGHT.
 
 Here is my amended version of the Start G-Code from Cura. To use this in Cura, go to:
 
@@ -64,7 +67,7 @@ Here is my amended version of the Start G-Code from Cura. To use this in Cura, g
 
 And paste in the following:
 
-```
+```gcode
 ; Vertex Delta Start Gcode
 M400
 G28 ; Home extruder

config/examples/linear_axes/Octopus 8 LINEAR_AXES/README.md

@@ -10,10 +10,10 @@ All axes in this example use the same steps/mm, acceleration, etc.
 In this example Marlin automatically maps extra axes to the unused E0, E1, E2, E3 and E4 (Z2) stepper ports.
 Endstop pins must be assigned manually, so this example assigns endstops as follows:
 
-```
+```cpp
-I_MIN_PIN PG11  // Z2-STOP
+#define I_MIN_PIN PG11  // Z2-STOP
-J_MIN_PIN PG12  // E0DET
+#define J_MIN_PIN PG12  // E0DET
-K_MIN_PIN PG13  // E1DET
+#define K_MIN_PIN PG13  // E1DET
-U_MIN_PIN PG14  // E2DET
+#define U_MIN_PIN PG14  // E2DET
-V_MIN_PIN PG15  // E3DET
+#define V_MIN_PIN PG15  // E3DET
 ```