Not for production use – use with caution!
The files that make up the Marlin firmware are being reorganized to provide a more managable structure.
Since the 1.1RC1, the following changes have been made:
-
File Layout -- The bulk of the code is moved into the hardware/marlin/avr/libraries/marlin/ folder. A trivial sketch that can be used to compile and upload the firmware is located at hardware/marlin/avr/libraries/marlin/examples/MarlinFirmware/MarlinFirmware.ino
-
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 hardware/marlin/avr/libraries/marlin/examples/MarlinFirmware/FirmwareCustomization.h for more information.
-
Coding Style -- The formatting of the source code is now controlled by the astyle program. The options which specify the style in use are found in the .astylerc file which is located in the top level folder of this repository. To reformat a file, run
astyle --options=.astylerc <file_name>. You will need to do this before committing the file to the git repository. Pull requests which do not conform to the specified style will be rejected by the automated tests in our Travis Intgration suite. -
Compilation Support -- The IDE_1.6.5 branch has the support routines to build the firmware using the Arduino IDE 1.6.5. At the present time, this support is incomplete. If you need them, you can retrieve earlier support routines from the RC branch of the Marlin Release Repository.
The dev branch contains the most up-to-date Marlin code. When reporting any issues, please check to see if they are resolved in this branch first. But let us know if issues exist in tagged releases so that we can document and patch them.
The RC branch contains the latest Marlin 1.1 pre-release candidate.
Development patches should be submitted as a Pull Request against the master branch
For the latest tagged version of Marlin (currently 1.0.2 – January 2015) you should switch to the Release Repository.
Testing of the 1.1 Release Candidate is under way. Marlin development needs to proceed with caution while the structural changes being implemented here are completed.
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.
The current Marlin dev team consists of:
- Scott Lahteine [@thinkyhead] - English
- Andreas Hardtung [@AnHardt] - Deutsch, English
- [@Wurstnase] - Deutsch, English
- F. Malpartida [@fmalpartida] - English, Spanish
- [@CONSULitAS] - Deutsch, English
- [@maverikou]
- Chris Palmer [@nophead]
- [@paclema]
- [@epatel]
- 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...
Marlin is published under the GPL 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.
