Skip to content
Snippets Groups Projects
README.md 3.39 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Marlin 3D Printer Firmware
    <img align="right" src="Documentation/Logo/Marlin%20Logo%20GitHub.png" />
    
    
     Documentation has moved to [marlinfirmware.org](http://www.marlinfirmware.org).
    
    
    ## Development Only
    
    
    __Not for production use – use with caution!__
    
    
    The [dev branch](https://github.com/MarlinFirmware/MarlinDev/tree/dev) 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.
    
    ## Testing
    The [RC branch](https://github.com/MarlinFirmware/MarlinDev/tree/RC) will contain the latest pre-release candidate.
    
    ## Submitting Patches
    Development patches should be submitted as a Pull Request against the [master](https://github.com/MarlinFirmware/MarlinDev/tree/master) branch
     
    For the latest tagged version of Marlin (currently 1.0.2 – January 2015) you should switch to the [Release Repository](https://github.com/MarlinFirmware/Marlin).
    
    Bo Herrmannsen's avatar
    Bo Herrmannsen committed
    
    ## Current Status: Bug Fixing
    
    
    Marlin development is being accelerated to catch up with a long list of issues. Check the Issues and Pull Requests links on the right to to see what we are currently working on.
    
    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
    
     - [@fmalpartida] - English, Spanish
    
     - [@CONSULitAS] - Deutsch, English
    
    Scott Lahteine's avatar
    Scott Lahteine committed
     - [@maverikou]
     - Chris Palmer [@nophead]
     - [@paclema]
     - [@epatel]
    
    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)