1
0
mirror of https://github.com/MarlinFirmware/Marlin.git synced 2024-11-29 23:07:42 +00:00
MarlinFirmware/README.md

62 lines
3.4 KiB
Markdown
Raw Normal View History

# Marlin 3D Printer Firmware
<img align="right" src="Documentation/Logo/Marlin%20Logo%20GitHub.png" />
2014-12-26 10:29:29 +00:00
Documentation has moved to [marlinfirmware.org](http://www.marlinfirmware.org).
2014-12-27 10:33:25 +00:00
## Release Branch
2015-01-06 10:59:11 +00:00
The Release branch contains the latest tagged version of Marlin (currently 1.0.2-1 January 2015). It also includes a version 1.0.1 (December 2014). Any version of Marlin before 1.0.1 (when we started tagging versions) can be collectively referred to as Marlin 1.0.0.
## Patches - 1.0.x Branch
Any patches developed for this family of releases will be found on the [1.0.x] branch](https://github.com/MarlinFirmware/Marlin/tree/1.0.x) of this repository.
## This Repository is Not For Feature Development
Development of future versions of Marlin is ongoing. However, to keep issues separate, that effort takes place in a companion [Development Repository](https://github.com/MarlinFirmware/MarlinDev/). Please make all suggestions for future features in that project. Issues raised here should be restricted to errors in the tagged releases.
## Current Status: In Development
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-01-06 11:02:42 +00:00
[![Coverity Scan Build Status](https://scan.coverity.com/projects/2224/badge.svg)](https://scan.coverity.com/projects/2224)
2015-01-06 21:22:35 +00:00
[![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
__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" to determine the time and date of the next event.
## Credits
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
2015-05-14 11:39:40 +00:00
- [@maverikou]
- Chris Palmer [@nophead]
- [@paclema]
- [@epatel]
2015-05-15 01:21:31 +00:00
- Erik van der Zalm [@ErikZalm]
- David Braam [@daid]
- Bernhard Kubicek [@bkubicek]
- Richard Wackerbarth [@Wackerbarth] - English
More features have been added by:
- Alberto Cotronei [@MagoKimbra]
- Lampmaker,
- Bradley Feldman,
- and others...
## License
2015-01-06 20:12:21 +00:00
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)