Skip to content
Snippets Groups Projects
README.md 3.66 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Marlin 3D Printer Firmware
    
    <img align="top" width=175 src="Documentation/Logo/Marlin%20Logo%20GitHub.png" />
    
     Documentation has moved to [marlinfirmware.org](http://www.marlinfirmware.org).
    
    
    ## Release Candidate -- Marlin 1.1.0-RC2 - 29 September 2015
    
    
    __Not for production use – use with caution!__
    
    
    For the latest tagged version of Marlin (currently 1.0.2 – January 2015) you should switch to the [Release branch](https://github.com/MarlinFirmware/Marlin/tree/Release).
    
    [This branch, "RC"](https://github.com/MarlinFirmware/Marlin/tree/RC), is our current pre-release candidate.
    
    Future development takes place in the [MarlinDev repository](https://github.com/MarlinFirmware/MarlinDev/).
    
    ## Recent Changes
    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
    Note: Do not propose added features. Patches to the Release Candidate are limited to corrections of coding errors for the functions that have been implemented.
    Please follow the proper style. Pull requests containing styling errors will have to be reworked.
    
    
    
    Bo Herrmannsen's avatar
    Bo Herrmannsen committed
    
    
    ## Current Status: Testing
    
    Bo Herrmannsen's avatar
    Bo Herrmannsen committed
    
    
    Please test this firmware and inform us of any issues where it fails to perform in a manner consistent with the designed functionality.
    
    Bo Herrmannsen's avatar
    Bo Herrmannsen committed
    
    [![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/MarlinDev.svg)](https://travis-ci.org/MarlinFirmware/MarlinDev)
    
    Bo Herrmannsen's avatar
    Bo Herrmannsen committed
    
    
    ##### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
    
    ## Contact
    
    
    Bo Herrmannsen's avatar
    Bo Herrmannsen committed
    __Google Hangout:__ <a href="https://plus.google.com/hangouts/_/gxn3wrea5gdhoo223yimsiforia" target="_blank">. Hangout</a> 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.
    
    Steffen Vogel's avatar
    Steffen Vogel committed
    ## Credits
    
    
    Steffen Vogel's avatar
    Steffen Vogel committed
    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
    
    Scott Lahteine's avatar
    Scott Lahteine committed
     - [@maverikou]
     - Chris Palmer [@nophead]
     - [@paclema]
    
     - Edward Patel [@epatel] - Swedish, English
    
    Scott Lahteine's avatar
    Scott Lahteine committed
     - Erik van der Zalm [@ErikZalm]
     - David Braam [@daid]
     - Bernhard Kubicek [@bkubicek]
    
     - Richard Wackerbarth [@Wackerbarth] - English
    
     - Roxanne Neufeld [@Roxy-3DPrintBoard] - English
    
    Steffen Vogel's avatar
    Steffen Vogel committed
    More features have been added by:
    
      - Alberto Cotronei [@MagoKimbra]
    
    Steffen Vogel's avatar
    Steffen Vogel committed
      - Lampmaker,
      - Bradley Feldman,
      - and others...
    
    Steffen Vogel's avatar
    Steffen Vogel committed
    
    
    ## License
    
    Marlin is published under the [GPL license](/Documentation/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)