diff --git a/README.md b/README.md index 08c23359..49ff87f1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ -# Marlin 3D Printer Firmware + + +# Marlin 3D Printer Firmware + +[![Build Status](https://travis-ci.org/MarlinFirmware/Marlin.svg?branch=2.0.x)](https://travis-ci.org/MarlinFirmware/Marlin) +![GitHub](https://img.shields.io/github/license/marlinfirmware/marlin.svg) +![GitHub contributors](https://img.shields.io/github/contributors/marlinfirmware/marlin.svg) +![GitHub Release Date](https://img.shields.io/github/release-date/marlinfirmware/marlin.svg) + +_Marlin_ is a firmware for RepRap machines, also known as _3D printers_. firmware to the next level by adding support for much faster 32-bit and ARM-based boards while improving support for 8-bit AVR boards through the use of a "hardware abstraction layer." + +Additional documentation can be found at the [Marlin Home Page](http://marlinfw.org/). +Please let us know if Marlin misbehaves in any way. Volunteers are standing by! ### BigTreeTech Updated their Firmware, get it here: https://github.com/bigtreetech/BIGTREETECH-SKR-mini-E3 ## Building Marlin 2.0 -To build Marlin 2.0 you'll need [PlatformIO](http://docs.platformio.org/en/latest/ide.html#platformio-ide). We've posted detailed instructions on [Building Marlin with PlatformIO for ReArm](http://marlinfw.org/docs/basics/install_rearm.html) (which applies well to other 32-bit boards). +To build Marlin you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](http://docs.platformio.org/en/latest/ide.html#platformio-ide) with _[Visual Studio Code](https://code.visualstudio.com/download)_. + +- [Installing Marlin (Arduino)](http://marlinfw.org/docs/basics/install_arduino.html) +- [Installing Marlin (VSCode)](http://marlinfw.org/docs/basics/install_platformio_vscode.html). ## Current Target @@ -23,11 +38,10 @@ Creality Ender-3 with SKR Mini E3 v1.2 and Creality BLTouch 3.1 - Enabled Linear Advance - Enabled Square Wave Stepping - Enabled Hybrid Threshold for TMC2209 Stepper Drivers -- Bed Size is 225x225mm +- Bed Size is 230x230mm - Enable Menu to Level Bed Corners (and Center) -- Pre-Heat for "Fillament Cold Pull" instead of Pre-heat for ABS +- Pre-Heat for "PLA" and "PETG" - Fix for EEPROM saving issue -- Using SoftwareSerialM instead to be able to use up-to-date TMCStepper library, instead of BTT outdated TMCStepper library. ## BLTouch Wiring @@ -46,23 +60,18 @@ Please make sure to go over the configuration of the system before installing th - [SKR_Mini_E3_v1.2_256K_BLTouch_v3.1](https://raw.githubusercontent.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/master/bin/SKR_Mini_E3_v1.2_256K_BLTouch_v3.1.bin) - [SKR_Mini_E3_v1.2_256K_Manual_Bed_Level](https://raw.githubusercontent.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/master/bin/SKR_Mini_E3_v1.2_256K_Manual_Bed_Level.bin) -Also added created the optional 512k variant - -- [SKR_Mini_E3_v1.2_512K_BLTouch_v3.1](https://raw.githubusercontent.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/master/bin/SKR_Mini_E3_v1.2_512K_BLTouch_v3.1.bin) -- [SKR_Mini_E3_v1.2_512K_Manual_Bed_Level](https://raw.githubusercontent.com/damvcoool/Marlin-2.0.x-SKR-Mini-E3-v1.2/master/bin/SKR_Mini_E3_v1.2_512KManual_Bed_Level.bin) - -Note: I use SKR_Mini_E3_v1.2_256K_BLTouch_v3.1 on my machine and it's the only firmware I have tested myself. +I am no longer providing 512k variant. ## Credits The current Marlin dev team consists of: - - Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA   [![Flattr Scott](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=thinkyhead&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software) - - Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)] - USA - - Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)] - USA - - Chris Pepper [[@p3p](https://github.com/p3p)] - UK - - João Brazio [[@jbrazio](https://github.com/jbrazio)] - Portugal - - Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)] - Netherlands   [![Flattr Erik](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software) +- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA   [Donate](http://www.thinkyhead.com/donate-to-marlin) / Flattr: [![Flattr Scott](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=thinkyhead&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software) +- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)] - USA +- Chris Pepper [[@p3p](https://github.com/p3p)] - UK +- Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)] - USA +- João Brazio [[@jbrazio](https://github.com/jbrazio)] - Portugal +- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)] - Netherlands   [![Flattr Erik](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software) ## License