diff --git a/README.md b/README.md index ad259a238d..acca5b1dbd 100644 --- a/README.md +++ b/README.md @@ -1,140 +1,81 @@ # Marlin 3D Printer Firmware + + +## Marlin 1.1.0 + +Marlin 1.1 represents an evolutionary leap over Marlin 1.0.2. It is the result of over two years of effort by several volunteers around the world who have paid meticulous and sometimes obsessive attention to every detail. For this release we focused on code quality, performance, stability, and overall user experience. Several new features have also been added, many of which require no extra hardware. + +For complete Marlin documentation click over to the [Marlin Homepage ](http://marlinfw.org/), where you will find in-depth articles, how-to videos, and tutorials on every aspect of Marlin, as the site develops. For release notes, see the [Releases](https://github.com/MarlinFirmware/Marlin/releases) page. + +## Stable Release Branch + +This Release branch contains the latest tagged version of Marlin (currently 1.1.0 – May 2017). + +Previous releases of Marlin include [1.0.2-2](https://github.com/MarlinFirmware/Marlin/tree/1.0.2-2) (December 2016) and [1.0.1](https://github.com/MarlinFirmware/Marlin/tree/1.0.1) (December 2014). Any version of Marlin prior to 1.0.1 (when we started tagging versions) can be collectively referred to as Marlin 1.0.0. + +## Contributing to Marlin + +Click on the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues) and [Pull Requests](https://github.com/MarlinFirmware/Marlin/pulls) links above at any time to see what we're currently working on. + +To submit patches and new features for Marlin 1.1 check out the [bugfix-1.1.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-1.1.x) branch, add your commits, and submit a Pull Request back to the `bugfix-1.1.x` branch. Periodically that branch will form the basis for the next minor release. + +Note that our "bugfix" branch will always contain the latest patches to the current release version. These patches may not be widely tested. As always, when using "nightly" builds of Marlin, proceed with full caution. + +## Current Status: In Development + +Marlin development has reached an important milestone with its first stable release in over 2 years. During this period we focused on cleaning up the code and making it more modern, consistent, readable, and sensible. + +## Future Development + +Arduino IDE now supports folder hierarchies, so Marlin 1.1 is the last "flat" version of Marlin. Version 1.2 will have a hierarchical file structure, and will form the starting-point for our integration of 32-bit CPU support. -[![Build Status](https://travis-ci.org/MarlinFirmware/Marlin.svg?branch=RCBugFix)](https://travis-ci.org/MarlinFirmware/Marlin) [![Coverity Scan Build Status](https://scan.coverity.com/projects/2224/badge.svg)](https://scan.coverity.com/projects/2224) +[![Travis Build Status](https://travis-ci.org/MarlinFirmware/Marlin.svg)](https://travis-ci.org/MarlinFirmware/Marlin) - - -Additional documentation can be found at [The Marlin Documentation Project](https://www.marlinfw.org/). -Please test this firmware and inform us if it misbehaves in any way, volunteers are standing by! - -## Release Candidate -- Marlin 1.1.0-RCBugFix - 6 Dec 2016 - -__Not for production use – use with caution!__ - -You can download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases). (The latest "stable" release of Marlin is 1.0.2-1.) - -The latest Release Candidate lives in the ["RC" branch](https://github.com/MarlinFirmware/Marlin/tree/RC). Bugs that we find in the current Release Candidate are patched in the ["RCBugFix" branch](https://github.com/MarlinFirmware/Marlin/tree/RCBugFix), so during beta testing this is where you can always find the latest code on its way towards release. - -## Recent Changes -- RCBugFix - - Fixed broken MBL - - M600 heater timeout option - -- RC8 - 06 Dec 2016 - - Major performance improvement for Graphical LCDs - - Simplified probe configuration - - Enable Auto Bed Leveling by type - - Reduce serial communication errors - - Make Bilinear (Mesh) Grid Leveling available for non-delta - - Support for Trinamic TMC2130 SilentStepStick SPI-based drivers - - Add `M211` to Enable/Disable Software Endstops - - Add `M355` to turn the case light on/off and set brightness - - Improved I2C class with full master/slave support - - Add `G38.2` `G38.3` command option for CNC style probing - - Add `MINIMUM_STEPPER_PULSE` option to adjust step pulse duration - - Add `R` parameter support for `G2`/`G3` - - Add `M43` optional command (`PINS_DEBUGGING`) - - Remove SCARA axis scaling - - Improved sanity checking of configuration - - Improved support for PlatformIO and command-line build - - Usable `DELTA_CALIBRATION_MENU` - - Support for Printrbot Rev.F - - New and updated languages - -- RC7 - 26 Jul 2016 - - Add Print Job Timer and Print Counter (`PRINTCOUNTER`) - - New `M600` Filament Change (`FILAMENT_CHANGE_FEATURE`) - - New `G12` Nozzle Clean (`NOZZLE_CLEAN_FEATURE`) - - New `G27` Nozzle Park (`NOZZLE_PARK_FEATURE`) - - Add support for `COREYZ` - - Add a new Advance Extrusion algorithm (`LIN_ADVANCE`) - - Add support for inches, Fahrenheit, Kelvin units (`INCH_MODE_SUPPORT`, `TEMPERATURE_UNITS_SUPPORT`) - - Better handling of `G92` shifting of the coordinate space - - Add Greek and Croatian languages - - Improve the Manual (Mesh) Bed Leveling user interface - - Add support for more boards, controllers, and probes: - - Vellemann K8400 (`BOARD_K8400`) - - RigidBot V2 (`BOARD_RIGIDBOARD_V2`) - - Cartesio UI (`BOARD_CNCONTROLS_12`) - - BLTouch probe sensor (`BLTOUCH`) - - Viki 2 with RAMPS and MKS boards - - Improve support for `DELTA` and other kinematics - - Improve thermal management, add `WATCH_BED_TEMP_PERIOD` - - Better handling of toolchange, multiple tools - - Add support for two X steppers `X_DUAL_STEPPER_DRIVERS` - - Add support for `SINGLENOZZLE`, `MIXING_EXTRUDER`, and `SWITCHING_EXTRUDER` - - Simplified probe configuration, allow usage without bed leveling - - And much more… See the [1.1.0-RC7 Change Log](https://github.com/MarlinFirmware/Marlin/releases/tag/1.1.0-RC7) for the complete list of changes. - -- RC6 - 24 Apr 2016 - - Marlin now requires Arduino version 1.6.0 or later - - Completed support for CoreXY / CoreXZ - - See the [1.1.0-RC6 Change Log](https://github.com/MarlinFirmware/Marlin/releases/tag/1.1.0-RC6) for all the changes. - -- RC5 - 01 Apr 2016 - - Warn if compiling with older versions (<1.50) of Arduino - - Fix various LCD menu issues - - Add formal support for MKSv1.3 and Sainsmart (RAMPS variants) - - Fix bugs in M104, M109, and M190 - - Fix broken M404 command - - Fix issues with M23 and "Start SD Print" - - More output for M111 - - Rename FILAMENT_SENSOR to FILAMENT_WIDTH_SENSOR - - Fix SD card bugs - - and a lot more - - See the [1.1.0-RC5 Change Log](https://github.com/MarlinFirmware/Marlin/releases/tag/1.1.0-RC5) for more! - -- RC4 - 24 Mar 2016 - - Many lingering bugs and nagging issues addressed - - Improvements to LCD menus, CoreXY/CoreXZ, Delta, Bed Leveling, and more… - -- RC3 - 01 Dec 2015 - - A number of language sensitive strings have been revised - - Formatting of the LCD display has been improved to handle negative coordinates better - - Various compiler-related issues have been corrected - -- RC2 - 29 Sep 2015 - - File styling reverted - - LCD update frequency reduced - -- RC1 - 19 Sep 2015 - - Published for testing - -## Submitting Patches -Proposed patches should be submitted as a Pull Request against the [RCBugFix](https://github.com/MarlinFirmware/Marlin/tree/RCBugFix) branch. - -- Don't submit new feature proposals. The RCBugFix branch is for fixing bugs in existing features. -- Do submit questions and concerns. The "naive" question is often the one we forget to ask. -- Follow the proper coding style. Pull requests with styling errors will be delayed. See our [Coding Standards](https://github.com/MarlinFirmware/Marlin/wiki/DNE-Coding-Standards) page for more information. - -### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin) +##### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin) +##### [Marlin Home Page](http://marlinfw.org/) +##### [Marlin Discussion Forum](http://forums.reprap.org/list.php?415) ## Credits The current Marlin dev team consists of: - + - Roxanne Neufeld [@Roxy-3D] - English - Scott Lahteine [@thinkyhead] - English - - [@Wurstnase] - Deutsch, English - - F. Malpartida [@fmalpartida] - English, Spanish + - Bob Kuhn [@Bob-the-Kuhn] - English + - Andreas Hardtung [@AnHardt] - Deutsch, English + - Nico Tonnhofer [@Wurstnase] - Deutsch, English - Jochen Groppe [@CONSULitAS] - Deutsch, English + - João Brazio [@jbrazio] - Portuguese, English + - Bo Hermannsen [@boelle] - Danish, English + - Bob Cousins [@bobc] - English - [@maverikou] - Chris Palmer [@nophead] - [@paclema] - - Edward Patel [@epatel] - Swedish, English - Erik van der Zalm [@ErikZalm] - David Braam [@daid] - Bernhard Kubicek [@bkubicek] - - Roxanne Neufeld [@Roxy-3DPrintBoard] - English More features have been added by: - - Alberto Cotronei [@MagoKimbra] - - Lampmaker, - - Bradley Feldman, - - and others... + - Alberto Cotronei [@MagoKimbra] - English, Italian + - Thomas Moore [@tcm0116] + - Ernesto Martinez [@emartinez167] + - Petr Zahradnik [@clexpert] + - Kai [@Kaibob2] + - Edward Patel [@epatel] + - F. Malpartida [@fmalpartida] - English, Spanish + - [@esenapaj] - English, Japanese + - [@benlye] + - [@Tannoo] + - [@teemuatlut] + - [@bgort] + - [@LVD-AC] + - [@paulusjacobus] + - ...and many others ## 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. +Marlin is published under the [GPL license](/COPYING.md) 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](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)