Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 5.12 KB

README.md

File metadata and controls

86 lines (59 loc) · 5.12 KB

Marlin 3D Printer Firmware

Documentation has moved to the [wiki](https://github.com/MarlinFirmware/MarlinDev/wiki).

This is the source code which produces the Marlin Firmware

Complete instructions for setting up the build environment and configuring the firmware can be found at the wiki. In order to build the firmware, you will also need to setup the build environment. The official build environment is based on the Arduino IDE 1.6.7.

Development Only

Not for production use – use with caution!

In Transition

The files that make up the Marlin firmware are being reorganized to provide a more managable structure.

Since the 1.1.0-RC2, the following changes have been made:

  1. File Layout -- The bulk of the code is moved into the /libraries/marlin/ folder. A trivial sketch that can be used to compile and upload the firmware is located at /libraries/marlin/examples/MarlinFirmware/MarlinFirmware.ino

  2. Configuration Files -- The configuration files are being reorganized. The configuration files from the Marlin 1.1 series are still available in the configurations folder. The procedure that you use to customize your configuration has changed. Please see /libraries/marlin/examples/MarlinFirmware/FirmwareCustomization.h for more information.

  3. Compilation Support -- Although they lack some of the build features provided, the code can also be compiled from the Arduino IDE 1.6.5 and by other methods. If you need them, you can retrieve earlier support routines from the RC branch of the Marlin Release Repository.

Branches

Development

The dev branch contains the most up-to-date development Marlin code. Please remember that this code is for developers only and may well contain non-working situations. Instructions for setting up the build environment and compiling the firmware can be found in our wiki.

Testing

The RC branch contains the latest Marlin 1.1 pre-release candidate. The RCBugFix branch has some additional corrections which will be included in the next release candidate.

Released Code

For the latest tagged version of Marlin (currently 1.0.2 – January 2015) you should switch to the Release Repository. Please see that repository for additional information.

Current Status

Testing of the 1.1 Release Candidate is under way.

The support structure for the new development work has recently been put in place. It is likely that there will be some modifications made to it as we gain experience using it.

Coverity Scan Build Status Travis Build Status

Contact

Google Hangout: . Hangout We have a hangout every 2 weeks. Search the issue list for "Hangout" and you will see what time and date the next event is going on.

Credits

The current Marlin dev team consists of:

  • Scott Lahteine [@thinkyhead] - English
  • [@Wurstnase] - Deutsch, English
  • F. Malpartida [@fmalpartida] - English, Spanish
  • [@CONSULitAS] - Deutsch, English
  • [@maverikou]
  • Chris Palmer [@nophead]
  • [@paclema]
  • Edward Patel [@epatel] - Swedish, English
  • Erik van der Zalm [@ErikZalm]
  • David Braam [@daid]
  • Bernhard Kubicek [@bkubicek]
  • Richard Wackerbarth [@Wackerbarth] - English
  • Roxanne Neufeld [@Roxy-3DPrintBoard] - English

More features have been added by:

  • Alberto Cotronei [@MagoKimbra]
  • Lampmaker,
  • Bradley Feldman,
  • and others...

License

Marlin is published under the GPL v3 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.

Flattr this git repo