Firmware/README.md

78 lines
3.8 KiB
Markdown
Raw Normal View History

# Marlin 3D Printer Firmware
<img align="top" width=175 src="Documentation/Logo/Marlin%20Logo%20GitHub.png" />
2015-11-15 19:23:37 +01:00
Additional documentation can be found in [our wiki](https://github.com/MarlinFirmware/Marlin/wiki/Main-Page).
## Release Candidate -- Marlin 1.1.0-RC3 - 01 December 2015
__Not for production use use with caution!__
Previously tagged versions of Marlin are not recommended. However, the latest patches to the Marlin 1.0 series can be found in the [1.0.x](https://github.com/MarlinFirmware/Marlin/tree/1.0.x) branch.
[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
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
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.
2015-05-09 14:59:48 +02:00
## Current Status: Testing
2015-05-09 14:59:48 +02:00
Please test this firmware and inform us of any issues where it fails to perform in a manner consistent with the designed functionality.
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/MarlinDev.svg)](https://travis-ci.org/MarlinFirmware/MarlinDev)
2015-05-09 14:59:48 +02:00
##### [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-07-30 14:49:28 +02:00
- [@Wurstnase] - Deutsch, English
- F. Malpartida [@fmalpartida] - English, Spanish
2015-07-30 14:49:28 +02:00
- [@CONSULitAS] - Deutsch, English
2015-05-14 13:40:07 +02:00
- [@maverikou]
- Chris Palmer [@nophead]
- [@paclema]
- Edward Patel [@epatel] - Swedish, English
2015-05-15 03:21:53 +02:00
- Erik van der Zalm [@ErikZalm]
- David Braam [@daid]
- Bernhard Kubicek [@bkubicek]
2015-09-03 04:38:23 +02:00
- Roxanne Neufeld [@Roxy-3DPrintBoard] - English
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](/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.
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)