2016-04-26 20:23:39 +00:00
# Marlin 3D Printer Firmware
2016-05-20 02:30:14 +00:00
2017-05-04 08:22:17 +00:00
[](https://travis-ci.org/MarlinFirmware/Marlin)
2016-05-20 02:30:14 +00:00
[](https://scan.coverity.com/projects/2224)
2017-05-04 08:22:17 +00:00
< img align = "top" width = 175 src = "buildroot/share/pixmaps/logo/marlin-250.png" / >
Additional documentation can be found at the [Marlin Home Page ](http://marlinfw.org/ ).
2017-05-21 00:13:04 +00:00
Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!
2017-05-04 08:22:17 +00:00
2017-07-27 08:02:53 +00:00
## Marlin 2.0 Bugfix Branch
2017-05-04 08:22:17 +00:00
__Not for production use. Use with caution!__
2017-09-06 11:28:32 +00:00
Marlin 2.0 is bringing open source RepRap firmware to the next level with support of much faster 32-bit processor boards.
This branch is for patches to the latest 2.0.x release version. Periodically this branch will form the basis for the next minor 2.0.x release.
2017-05-04 08:22:17 +00:00
2017-07-27 08:02:53 +00:00
Download earlier versions of Marlin on the [Releases page ](https://github.com/MarlinFirmware/Marlin/releases ).
2017-05-04 08:22:17 +00:00
2017-09-06 11:28:32 +00:00
## Hardware Abstraction Layer (HAL)
Marlin 2.0 adds a new abstraction layer so that Marlin can build and run on 32-bit boards while still retaining the ability to build and run on 8-bit AVR. In this way, new features can be enhanced for more powerful platforms while still supporting AVR, whereas splitting up the code makes it hard to follow these changes and keep them in sync.
### Current HALs
name|processor|speed|flash|sram|logic|fpu
----|---------|-----|-----|----|-----|---
2017-11-04 15:23:12 +00:00
[Arduino AVR ](https://www.arduino.cc/ )|ATmega, ATTiny, etc.|16-20MHz|64-256k|2-8k|5V|no
2017-09-06 11:28:32 +00:00
[Teensy++ 2.0 ](http://www.microchip.com/wwwproducts/en/AT90USB1286 )|[AT90USB1286](http://www.microchip.com/wwwproducts/en/AT90USB1286)|16MHz|128k|8k|5V|no
[Due ](https://www.arduino.cc/en/Guide/ArduinoDue ), [RAMPS-FD ](http://www.reprap.org/wiki/RAMPS-FD ), etc.|[SAM3X8E ARM-Cortex M3](http://www.microchip.com/wwwproducts/en/ATsam3x8e)|84MHz|512k|64+32k|3.3V|no
[Re-ARM ](https://www.kickstarter.com/projects/1245051645/re-arm-for-ramps-simple-32-bit-upgrade )|[LPC1768 ARM-Cortex M3](http://www.nxp.com/products/microcontrollers-and-processors/arm-based-processors-and-mcus/lpc-cortex-m-mcus/lpc1700-cortex-m3/512kb-flash-64kb-sram-ethernet-usb-lqfp100-package:LPC1768FBD100)|100MHz|512k|32+16+16k|3.3-5V|no
2017-10-25 20:35:24 +00:00
[MKS SBASE ](http://forums.reprap.org/read.php?13,499322 )|LPC1768 ARM-Cortex M3|100MHz|512k|32+16+16k|3.3-5V|no
2017-11-01 16:49:51 +00:00
[Azteeg X5 GT ](https://www.panucatt.com/azteeg_X5_GT_reprap_3d_printer_controller_p/ax5gt.htm )|LPC1769 ARM-Cortex M3|120MHz|512k|32+16+16k|3.3-5V|no
2017-09-06 11:28:32 +00:00
[Teensy 3.5 ](https://www.pjrc.com/store/teensy35.html )|ARM-Cortex M4|120MHz|512k|192k|3.3-5V|yes
[Teensy 3.6 ](https://www.pjrc.com/store/teensy36.html )|ARM-Cortex M4|180MHz|1M|256k|3.3V|yes
### HALs in Development
name|processor|speed|flash|sram|logic|fpu
----|---------|-----|-----|----|-----|---
[STEVAL-3DP001V1 ](http://www.st.com/en/evaluation-tools/steval-3dp001v1.html )|[STM32F401VE Arm-Cortex M4](http://www.st.com/en/microcontrollers/stm32f401ve.html)|84MHz|512k|64+32k|3.3-5V|yes
[Smoothieboard ](http://reprap.org/wiki/Smoothieboard )|LPC1769 ARM-Cortex M3|120MHz|512k|64k|3.3-5V|no
2017-05-04 08:22:17 +00:00
## Submitting Patches
2017-09-06 11:28:32 +00:00
Proposed patches should be submitted as a Pull Request against the ([bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) branch.
2017-05-04 08:22:17 +00:00
2017-07-27 08:02:53 +00:00
- This branch is for fixing bugs and integrating any new features for the duration of the Marlin 2.0.x life-cycle.
- 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 ).
2017-05-04 08:22:17 +00:00
### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
2016-04-26 20:23:39 +00:00
## Credits
The current Marlin dev team consists of:
2017-05-08 19:00:38 +00:00
- Roxanne Neufeld [[@Roxy-3D ](https://github.com/Roxy-3D )] - English
- Scott Lahteine [[@thinkyhead ](https://github.com/thinkyhead )] - English
- Bob Kuhn [[@Bob-the-Kuhn ](https://github.com/Bob-the-Kuhn )] - English
2017-07-27 08:02:53 +00:00
- Chris Pepper [[@p3p ](https://github.com/p3p )] - English
2017-05-08 19:00:38 +00:00
- João Brazio [[@jbrazio ](https://github.com/jbrazio )] - Portuguese, English
2016-04-26 20:23:39 +00:00
## License
2017-05-04 08:22:17 +00:00
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.
2016-04-26 20:23:39 +00:00
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.
