135 lines
9.0 KiB
Markdown
135 lines
9.0 KiB
Markdown
<p align="center"><img src="buildroot/share/pixmaps/logo/marlin-outrun-nf-500.png" height="250" alt="MarlinFirmware's logo" /></p>
|
||
|
||
<h1 align="center">Marlin 3D Printer Firmware</h1>
|
||
|
||
<p align="center">
|
||
<a href="/LICENSE"><img alt="GPL-V3.0 License" src="https://img.shields.io/github/license/marlinfirmware/marlin.svg"></a>
|
||
<a href="https://github.com/MarlinFirmware/Marlin/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/marlinfirmware/marlin.svg"></a>
|
||
<a href="https://github.com/MarlinFirmware/Marlin/releases"><img alt="Last Release Date" src="https://img.shields.io/github/release-date/MarlinFirmware/Marlin"></a>
|
||
<a href="https://github.com/MarlinFirmware/Marlin/actions"><img alt="CI Status" src="https://github.com/MarlinFirmware/Marlin/actions/workflows/test-builds.yml/badge.svg"></a>
|
||
<a href="https://github.com/sponsors/thinkyhead"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/thinkyhead?color=db61a2"></a>
|
||
<br />
|
||
<a href="https://fosstodon.org/@marlinfirmware"><img alt="Follow MarlinFirmware on Mastodon" src="https://img.shields.io/mastodon/follow/109450200866020466?domain=https%3A%2F%2Ffosstodon.org&logoColor=%2300B&style=social"></a>
|
||
</p>
|
||
|
||
Additional documentation can be found at the [Marlin Home Page](https://marlinfw.org/).
|
||
Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!
|
||
|
||
## Marlin 2.1
|
||
|
||
Marlin 2.1 continues to support both 32-bit ARM and 8-bit AVR boards while adding support for up to 9 coordinated axes and to up to 8 extruders.
|
||
|
||
Download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases).
|
||
|
||
## Example Configurations
|
||
|
||
Before building Marlin you'll need to configure it for your specific hardware. Your vendor should have already provided source code with configurations for the installed firmware, but if you ever decide to upgrade you'll need updated configuration files. Marlin users have contributed dozens of tested example configurations to get you started. Visit the [MarlinFirmware/Configurations](https://github.com/MarlinFirmware/Configurations) repository to find the right configuration for your hardware.
|
||
|
||
## Building Marlin 2.1
|
||
|
||
To build Marlin 2.1 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). Detailed build and install instructions are posted at:
|
||
|
||
- [Installing Marlin (Arduino)](http://marlinfw.org/docs/basics/install_arduino.html)
|
||
- [Installing Marlin (VSCode)](http://marlinfw.org/docs/basics/install_platformio_vscode.html).
|
||
|
||
## Hardware Abstraction Layer (HAL)
|
||
|
||
Marlin 2.0 introduced a layer of abstraction to allow all the existing high-level code to be built for 32-bit platforms while still retaining full 8-bit AVR compatibility. Retaining AVR compatibility and a single code-base is important to us, because we want to make sure that features and patches get as much testing and attention as possible, and that all platforms always benefit from the latest improvements.
|
||
|
||
### Supported Platforms
|
||
|
||
Platform|MCU|Example Boards
|
||
--------|---|-------
|
||
[Arduino AVR](https://www.arduino.cc/)|ATmega|RAMPS, Melzi, RAMBo
|
||
[Teensy++ 2.0](https://www.microchip.com/en-us/product/AT90USB1286)|AT90USB1286|Printrboard
|
||
[Arduino Due](https://www.arduino.cc/en/Guide/ArduinoDue)|SAM3X8E|RAMPS-FD, RADDS, RAMPS4DUE
|
||
[ESP32](https://github.com/espressif/arduino-esp32)|ESP32|FYSETC E4, E4d@BOX, MRR
|
||
[LPC1768](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-cortex-m3/512-kb-flash-64-kb-sram-ethernet-usb-lqfp100-package:LPC1768FBD100)|ARM® Cortex-M3|MKS SBASE, Re-ARM, Selena Compact
|
||
[LPC1769](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-cortex-m3/512-kb-flash-64-kb-sram-ethernet-usb-lqfp100-package:LPC1769FBD100)|ARM® Cortex-M3|Smoothieboard, Azteeg X5 mini, TH3D EZBoard
|
||
[STM32F103](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html)|ARM® Cortex-M3|Malyan M200, GTM32 Pro, MKS Robin, BTT SKR Mini
|
||
[STM32F401](https://www.st.com/en/microcontrollers-microprocessors/stm32f401.html)|ARM® Cortex-M4|ARMED, Rumba32, SKR Pro, Lerdge, FYSETC S6, Artillery Ruby
|
||
[STM32F7x6](https://www.st.com/en/microcontrollers-microprocessors/stm32f7x6.html)|ARM® Cortex-M7|The Borg, RemRam V1
|
||
[STM32G0B1RET6](https://www.st.com/en/microcontrollers-microprocessors/stm32g0x1.html)|ARM® Cortex-M0+|BigTreeTech SKR mini E3 V3.0
|
||
[STM32H743xIT6](https://www.st.com/en/microcontrollers-microprocessors/stm32h743-753.html)|ARM® Cortex-M7|BigTreeTech SKR V3.0, SKR EZ V3.0, SKR SE BX V2.0/V3.0
|
||
[SAMD51P20A](https://www.adafruit.com/product/4064)|ARM® Cortex-M4|Adafruit Grand Central M4
|
||
[Teensy 3.5](https://www.pjrc.com/store/teensy35.html)|ARM® Cortex-M4|
|
||
[Teensy 3.6](https://www.pjrc.com/store/teensy36.html)|ARM® Cortex-M4|
|
||
[Teensy 4.0](https://www.pjrc.com/store/teensy40.html)|ARM® Cortex-M7|
|
||
[Teensy 4.1](https://www.pjrc.com/store/teensy41.html)|ARM® Cortex-M7|
|
||
Linux Native|x86/ARM/etc.|Raspberry Pi
|
||
|
||
## Submitting Patches
|
||
|
||
- Submit **Bug Fixes** as Pull Requests to the ([bugfix-2.1.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.1.x)) branch.
|
||
- Follow the [Coding Standards](http://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers.
|
||
- Please submit your questions and concerns to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues).
|
||
|
||
## Marlin Support
|
||
|
||
The Issue Queue is reserved for Bug Reports and Feature Requests. To get help with configuration and troubleshooting, please use the following resources:
|
||
|
||
- [Marlin Documentation](https://marlinfw.org) - Official Marlin documentation
|
||
- [Marlin Discord](https://discord.gg/n5NJ59y) - Discuss issues with Marlin users and developers
|
||
- Facebook Group ["Marlin Firmware"](https://www.facebook.com/groups/1049718498464482/)
|
||
- RepRap.org [Marlin Forum](https://forums.reprap.org/list.php?415)
|
||
- Facebook Group ["Marlin Firmware for 3D Printers"](https://www.facebook.com/groups/3Dtechtalk/)
|
||
- [Marlin Configuration](https://www.youtube.com/results?search_query=marlin+configuration) on YouTube
|
||
|
||
## Contributors
|
||
|
||
Marlin is constantly improving thanks to a huge number of contributors from all over the world bringing their specialties and talents. Huge thanks are due to [all the contributors](https://github.com/MarlinFirmware/Marlin/graphs/contributors) who regularly patch up bugs, help direct traffic, and basically keep Marlin from falling apart. Marlin's continued existence would not be possible without them.
|
||
|
||
## Administration
|
||
|
||
Regular users can open and close their own issues, but only the administrators can do project-related things like add labels, merge changes, set milestones, and kick trolls. The current Marlin admin team consists of:
|
||
|
||
<table align="center">
|
||
<tr><td>Project Maintainer</td></tr>
|
||
<tr><td>
|
||
|
||
🇺🇸 **Scott Lahteine**
|
||
[@thinkyhead](https://github.com/thinkyhead)
|
||
[<kbd> Donate 💸 </kbd>](https://www.thinkyhead.com/donate-to-marlin)
|
||
|
||
</td><td>
|
||
|
||
🇺🇸 **Roxanne Neufeld**
|
||
[@Roxy-3D](https://github.com/Roxy-3D)
|
||
|
||
🇺🇸 **Keith Bennett**
|
||
[@thisiskeithb](https://github.com/thisiskeithb)
|
||
[<kbd> Donate 💸 </kbd>](https://github.com/sponsors/thisiskeithb)
|
||
|
||
🇺🇸 **Jason Smith**
|
||
[@sjasonsmith](https://github.com/sjasonsmith)
|
||
|
||
</td><td>
|
||
|
||
🇧🇷 **Victor Oliveira**
|
||
[@rhapsodyv](https://github.com/rhapsodyv)
|
||
|
||
🇬🇧 **Chris Pepper**
|
||
[@p3p](https://github.com/p3p)
|
||
|
||
🇳🇿 **Peter Ellens**
|
||
[@ellensp](https://github.com/ellensp)
|
||
[<kbd> Donate 💸 </kbd>](https://ko-fi.com/ellensp)
|
||
|
||
</td><td>
|
||
|
||
🇺🇸 **Bob Kuhn**
|
||
[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)
|
||
|
||
🇳🇱 **Erik van der Zalm**
|
||
[@ErikZalm](https://github.com/ErikZalm)
|
||
[<kbd> Donate 💸 </kbd>](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
|
||
|
||
</td></tr>
|
||
</table>
|
||
|
||
## License
|
||
|
||
Marlin is published under the [GPL license](/LICENSE) because we believe in open development. The GPL comes with both rights and obligations. Whether you use Marlin firmware as the driver for your open or closed-source product, you must keep Marlin open, and you must provide your compatible Marlin source code to end users upon request. The most straightforward way to comply with the Marlin license is to make a fork of Marlin on Github, perform your modifications, and direct users to your modified fork.
|
||
|
||
While we can't prevent the use of this code in products (3D printers, CNC, etc.) that are closed source or crippled by a patent, we would prefer that you choose another firmware or, better yet, make your own.
|