Firmware/README.md

59 lines
3.3 KiB
Markdown
Raw Normal View History

# 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 Branch
__Not for production use use with caution!__
The Development 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.
There is now also an ["Integration" branch](https://github.com/MarlinFirmware/Marlin/tree/Integration) which will be used in development to migrate changes for wider testing from the Development branch on their way to Release. It's a nascent branch, so for now please rely on Development and Release for issues and features under most active discussion.
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).
2015-05-09 14:59:48 +02:00
## 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.
2015-05-09 14:59:48 +02:00
[![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)
##### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
## Contact
2015-05-09 23:27:54 +02:00
__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.
2015-01-08 19:48:56 +01:00
## Credits
2015-01-08 19:54:46 +01:00
The current Marlin dev team consists of:
- Scott Lahteine [@thinkyhead] - English
2015-05-14 13:43:10 +02:00
- Andreas Hardtung [@AnHardt]
2015-05-14 13:40:07 +02:00
- [@Wurstnase]
- [@fmalpartida] - English, Spanish
2015-05-14 13:40:07 +02:00
- [@CONSULitAS]
- [@maverikou]
- Chris Palmer [@nophead]
- [@paclema]
- [@epatel]
2015-05-15 03:21:53 +02:00
- Erik van der Zalm [@ErikZalm]
- David Braam [@daid]
- Bernhard Kubicek [@bkubicek]
2015-03-06 05:02:28 +01:00
2015-01-08 19:54:46 +01:00
More features have been added by:
- Alberto Cotronei [@MagoKimbra]
2015-01-08 19:54:46 +01:00
- Lampmaker,
- Bradley Feldman,
- and others...
2015-01-08 19:48:56 +01:00
2015-03-06 05:02:28 +01:00
## 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)