Skip to content

Commit 58f3843

Browse files
thisiskeithbthisiskeithb
authored
📝 Improve, clean up READMEs (#988)
1 parent 41c598d commit 58f3843

File tree

18 files changed

+78
-89
lines changed

18 files changed

+78
-89
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Usage
44
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:
5-
```sh
5+
```shell
66
stm32flash -w firmware.bin -v -g 0x0 -b 115200 <YOUR COM/SERIAL PORT HERE>
77
```
88

‎config/examples/BIQU/Hurakan/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ The Biqu Hurakan ships with a BigTreeTech Manta M4P motherboard which includes a
2121

2222
# Update Hurakan CB1 Image Defaults
2323

24-
⚠️ Start with the latest `CB1_Debian11_Klipper_kernel*.img.xz` (full) image from [bigtreetech/CB1/releases](https://github.com/bigtreetech/CB1/releases). ⚠️
24+
> [!IMPORTANT]
25+
> Start with the latest `CB1_Debian11_Klipper_kernel*.img.xz` (full) image from [bigtreetech/CB1/releases](https://github.com/bigtreetech/CB1/releases).
2526
2627
## SSH into to the CB1
2728

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

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
# Ender-5 Plus with BTT SKR 3 Configurations for Marlin Firmware
22

3-
## Important
4-
5-
The LCD will need the cable modified to fit the SKR 3 motherboard.
6-
Four pins, tx2-pa10 rx2-pa9 gnd-g 5v-+5v, ( See the boards silkscreens for pin labels)
3+
> [!IMPORTANT]
4+
> LCD cable will need to be modified to fit the SKR 3 motherboard (See board silkscreens for pin labels):
5+
>
6+
> | LCD -> SKR 3 |
7+
> |-----------------|
8+
> | `TX2` -> `PA10` |
9+
> | `RX2` -> `PA9` |
10+
> | `GND` -> `G` |
11+
> | `5V` -> `+5V` |
712
813
## About
914

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

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Ender-5 Plus Configurations for Marlin Firmware
22

3-
## Important
4-
5-
NOTE: The Ender-5 LCD stock firmware is only compatible with Creality firmware. The LCD standard UI will not function. This is expected.
3+
> [!IMPORTANT]
4+
> The Ender-5 LCD stock firmware is only compatible with Creality firmware. The LCD standard UI will not function. This is expected.
65
76
## Marlin DGUS UI Instructions
87

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Ender-5 Plus Configurations for Marlin Firmware
22

3-
## Important
4-
5-
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.
3+
> [!IMPORTANT]
4+
> 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.
65
76
## Marlin DGUS UI "Reloaded" Instructions
87

@@ -32,4 +31,4 @@ The Ender-5 stock LCD can optionally use a customized Marlin DGUS interface. To
3231

3332
## Restoring Factory Firmware
3433

35-
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.
34+
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

-14
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,5 @@
11
# Ender-5 with BigTreeTech SKR Mini E3 v2.0
22

3-
## Build with "Auto Build Marlin"
4-
5-
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.
6-
7-
## Build with PlatformIO
8-
9-
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.
10-
11-
To make the main "Build" button apply to this board's environment, edit the `platformio.ini` section `[platformio]` and change `default_envs` to
12-
13-
```ini
14-
default_envs = STM32F103RC_btt_512K
15-
```
16-
173
## Older Leadscrew
184

195
> [!NOTE]

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
## Elegoo Neptune 2/Neptune 2D/Neptune 2S Configuration
22

3-
***IMPORTANT:*** The firmware binary file must be named `elegoo.bin` or it will not flash.
3+
> [!IMPORTANT]
4+
> The firmware binary file must be named `elegoo.bin` or it will not flash.
45
56
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.
67

7-
NOTE: The original Neptune 2 and 2S use the same configurations, but the 2S always uses the 1.3 version of the board.
8+
> [!NOTE]
9+
> The original Neptune 2 and 2S use the same configurations, but the 2S always uses the 1.3 version of the board.
810
911
### ZNP Robin Nano 1.2 boards:
1012
- `Configuration.h`: Disable `IS_BOARD_1_3`.

‎config/examples/Felix/DUAL/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Bringing silky smooth prints to Felix.
1010
- [Stable version](https://github.com/MarlinFirmware/Marlin/tree/Development)
1111
- In both cases use the "Download Zip" button on the right.
1212

13-
```
13+
```shell
1414
cd Marlin/src
1515
cp config/examples/Felix/Configuration_adv.h .
1616
```

‎config/examples/Felix/Single/README.md

+18-8
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Bringing silky smooth prints to Felix.
1010
- [Stable version](https://github.com/MarlinFirmware/Marlin/tree/Development)
1111
- In both cases use the "Download Zip" button on the right.
1212

13-
```
13+
```shell
1414
cd Marlin/src
1515
cp config/examples/Felix/Configuration_adv.h .
1616
```
@@ -19,11 +19,15 @@ The next step depends on your setup:
1919

2020
### Single Extruder Configuration
2121

22-
cp config/examples/Felix/Configuration.h .
22+
```shell
23+
cp config/examples/Felix/Configuration.h .
24+
```
2325

2426
### Dual Extruder Configuration
2527

26-
cp config/examples/Felix/DUAL/Configuration.h Configuration.h
28+
```shell
29+
cp config/examples/Felix/DUAL/Configuration.h Configuration.h
30+
```
2731

2832
### Compile Firmware
2933

@@ -43,17 +47,23 @@ The next step depends on your setup:
4347

4448
Find the latest Arduino build:
4549

46-
ls -altr /tmp/
47-
drwxr-xr-x 5 chrono users 12288 Mar 3 21:41 build6072035599686630843.tmp
50+
```shell
51+
ls -altr /tmp/
52+
drwxr-xr-x 5 chrono users 12288 Mar 3 21:41 build6072035599686630843.tmp
53+
```
4854

4955
Copy the firmware to your printer host:
5056

51-
scp /tmp/build6072035599686630843.tmp/Marlin.cpp.hex a.b.c.d:/tmp/
57+
```shell
58+
scp /tmp/build6072035599686630843.tmp/Marlin.cpp.hex a.b.c.d:/tmp/
59+
```
5260

5361
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:
5462

55-
avrdude -C/etc/avrdude.conf -v -v -v -patmega2560 -cwiring -P/dev/ttyUSB0 \
56-
-b115200 -D -Uflash:w:/tmp/Marlin.cpp.hex:i
63+
```shell
64+
avrdude -C/etc/avrdude.conf -v -v -v -patmega2560 -cwiring -P/dev/ttyUSB0 \
65+
-b115200 -D -Uflash:w:/tmp/Marlin.cpp.hex:i
66+
```
5767

5868
## Acknowledgements
5969

‎config/examples/JGAurora/A5/README.md

+2-24
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,7 @@
11
# Configuration for JGAurora A5 printer
22

3-
## Firmware Installation Instructions
4-
5-
To install custom firmware:
6-
7-
- Download and install arduino IDE software from https://www.arduino.cc/en/Main/Software
8-
- Plug in A5 to your computer via USB cable
9-
- In arduino IDE, under the Tools menu, set:
10-
– **Board** to "Arduino/Genuino Mega or Mega 2560"
11-
– ***Processor*** to "Atmega 2560 (Mega 2560)"
12-
– **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.
13-
- 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.
14-
- [macOS CH340 Serial Driver](http://sampin.ch/ch340-driver-mac)
15-
- [Windows CH340 Serial Driver](https://sparks.gogo.co.nz/ch340.html)
16-
- Install the u8glib library using the library manager in the menu "Sketch -> Include Library -> Manage Libraries."
17-
- 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.
18-
- Close all other programs (Cura, Repetier Host, JGCreat, etc.) that could connect to the serial port.
19-
- Open the "Marlin.ino" file in Arduino IDE and wait for the new project window to appear.
20-
- Select "Upload" from the "Sketch" menu or click the Upload button.
21-
- Wait for the firmware to finish uploading and verifying. This may take a couple of minutes.
22-
- Plug the LCD connector back in.
23-
- 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."
24-
- In the input box, enter the following G-code commands:
25-
- `M502` (press return) to reset settings (in RAM) to your configured defaults.
26-
- `M500` (press return) to write settings and initialize the EEPROM.
3+
> [!IMPORTANT]
4+
> 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.
275
286
## Graphical Display
297

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

+7-5
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ Flags specific to this printer/configuration:
1515
- `SUPERPINDA` - SuperPinda present?
1616

1717
## Upgrade Notes
18-
* ⚠️ Cut or desolder the Z & E driver DIAG pins or they will interfere with PINDA & filament runout detection. ⚠️
19-
* Set the jumpers under your drivers to "TMC2208-UART MODE":
20-
21-
<img src="https://user-images.githubusercontent.com/13375512/74117621-24415000-4b6d-11ea-8811-f867e187ea0c.png" width="50%">
18+
> [!IMPORTANT]
19+
> * Cut or desolder the Z & E driver DIAG pins or they will interfere with PINDA & filament runout detection.
20+
> * Set the jumpers under your drivers to "TMC2208-UART MODE":
21+
>
22+
> <img src="https://user-images.githubusercontent.com/13375512/74117621-24415000-4b6d-11ea-8811-f867e187ea0c.png" width="50%">
2223
2324
## Changes to Start G-code
24-
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.
25+
> [!IMPORTANT]
26+
> 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.
2527
2628
Below are some example start G-code scripts from popular slicers to get you started.
2729

‎config/examples/Tronxy/X5SA/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
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.
1717

1818
1. Create a file named `savesettings.gcode` with the following content:
19-
```
19+
```gcode
2020
M6046 ; sdcard access
2121
M8512 "currentconfig.gcode" ; save settings to file
2222
```

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ use the original version.
1919
If you have a VM8204 upgraded Z axis and coupler, ensure the following line
2020
is uncommented. Otherwise comment it out:
2121

22-
```
22+
```cpp
2323
#define K8200_K8204
2424
```
2525
If you have the VM8201 display unit, uncomment the following line
26-
```
26+
```cpp
2727
//#define K8200_VM8201
2828
```
2929

3030
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
3131
the following is uncommented, otherwise comment it out
32-
```
32+
```cpp
3333
#define FULLGRAPHIC_CONTROLLER_LCD_SD
3434
```
3535

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Like its predecessor, (K8200), the K8400 is a 3Drag clone. There are some minor
66

77
Single and dual head configurations provided. Copy the correct Configuration.h and Configuration_adv.h to the /src/config directory.
88

9-
**NOTE: This configuration includes the community sourced feed rate fix. Use 100% feed rate in Repetier!**
9+
> [!NOTE]
10+
> This configuration includes the community sourced feed rate fix. Use 100% feed rate in Repetier!
1011
1112
For implementation and updated K8400 firmware, see https://github.com/birkett/Velleman-K8400-Firmware
1213

‎config/examples/WASP/PowerWASP/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The bootloader looks for byte in EEPROM at address 0x3FF:
5050

5151
To generate a bin file you need issue the following command on you apps elf executable:
5252

53-
```
53+
```shell
5454
avr-objcopy -I elf32-avr -O binary firmware.cpp.elf firmware.bin
5555
```
5656

@@ -59,22 +59,22 @@ file in you apps build directory.
5959

6060
### Using olimex usb to upload bootloader
6161

62-
```
62+
```shell
6363
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
6464
```
6565

66-
```
66+
```shell
6767
avrdude -p m2560 -c stk500v2 -P /dev/tty.usbmodemfa131 -F -U flash:w:stk500boot.hex -b 115200 -B1 -U lock:w:0x0F:m
6868
```
6969

70-
```
70+
```shell
7171
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
7272
```
7373

74-
```
74+
```shell
7575
avrdude -p m2560 -c stk500v2 -P /dev/tty.usbmodemfd131 -U flash:w:stk500boot_v2_mega2560.hex -U lock:w:0x0F:m -v
7676
```
7777

78-
```
78+
```shell
7979
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
8080
```

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

+6-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ These configurations activate many of the new advanced features of the Marlin fi
66
* Auto Bed Leveling
77
* Pause & Filament Change
88

9-
**Important**: Before doing anything else after updating the firmware, go to `Configuration > Advanced Settings > Initialize EEPROM` to get rid of old configurations.
9+
> [!IMPORTANT]
10+
> Before doing anything else after updating the firmware, go to `Configuration > Advanced Settings > Initialize EEPROM` to get rid of old configurations.
1011
1112
Then you should execute `Configuration > Delta Calibration > Set Delta Height` and also run `Configuration > Delta Configuration > Probe Z-offset` to verify the Probe offset.
1213

@@ -19,7 +20,8 @@ Please do a manual paper test (moving the nozzle slowly down to Z0 and checking
1920

2021
# Select the Configuration
2122

22-
**Please select the correct values at the start of the Configuration.h file**
23+
> [!IMPORTANT]
24+
> Please select the correct values at the start of the Configuration.h file
2325
2426
The Kossel comes in 3 versions:
2527

@@ -39,7 +41,8 @@ Typically the probes for the Anycubic Delta Kossel printers come in two differen
3941

4042
![Version 2 Probe](images/Version2Probe.jpg)
4143

42-
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:
44+
> [!IMPORTANT]
45+
> 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:
4346
4447
* `Configuration > Advanced Settings > Initialize EEPROM`
4548
* `Motion > Move Axis > Soft Endstops` : `Off`

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

+5-2
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,18 @@ Bilinear Leveling uses the same approach as the original firmware, with the adva
5656

5757
## Unified Bed Leveling and Cura
5858

59-
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.**
59+
Unified Bed Leveling is more accurate due to the addition of manual probing, but requires changes to the Cura settings.
60+
61+
> [!IMPORTANT]
62+
> 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.
6063
6164
Here is my amended version of the Start G-Code from Cura. To use this in Cura, go to:
6265

6366
*Preferences -> Configure Cura -> Printers -> Vertex Delta K8800 -> Machine Settings -> Start G-Code*
6467

6568
And paste in the following:
6669

67-
```
70+
```gcode
6871
; Vertex Delta Start Gcode
6972
M400
7073
G28 ; Home extruder

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ All axes in this example use the same steps/mm, acceleration, etc.
1010
In this example Marlin automatically maps extra axes to the unused E0, E1, E2, E3 and E4 (Z2) stepper ports.
1111
Endstop pins must be assigned manually, so this example assigns endstops as follows:
1212

13-
```
14-
I_MIN_PIN PG11 // Z2-STOP
15-
J_MIN_PIN PG12 // E0DET
16-
K_MIN_PIN PG13 // E1DET
17-
U_MIN_PIN PG14 // E2DET
18-
V_MIN_PIN PG15 // E3DET
13+
```cpp
14+
#define I_MIN_PIN PG11 // Z2-STOP
15+
#define J_MIN_PIN PG12 // E0DET
16+
#define K_MIN_PIN PG13 // E1DET
17+
#define U_MIN_PIN PG14 // E2DET
18+
#define V_MIN_PIN PG15 // E3DET
1919
```

0 commit comments

Comments
 (0)