📝 Improve, clean up READMEs (#988)

This commit is contained in:
Keith Bennett 2023-11-14 02:51:08 -08:00 committed by GitHub
parent 41c598df02
commit 58f3843bc6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 78 additions and 89 deletions

View file

@ -1,9 +1,14 @@
# Ender-5 Plus with BTT SKR 3 Configurations for Marlin Firmware
## Important
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)
> [!IMPORTANT]
> LCD cable will need to be modified to fit the SKR 3 motherboard (See board silkscreens for pin labels):
>
> | LCD -> SKR 3 |
> |-----------------|
> | `TX2` -> `PA10` |
> | `RX2` -> `PA9` |
> | `GND` -> `G` |
> | `5V` -> `+5V` |
## About

View file

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

View file

@ -1,8 +1,7 @@
# Ender-5 Plus Configurations for Marlin Firmware
## Important
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.
> [!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.
## 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.

View file

@ -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]