Marlin_Firmware/README.md

78 lines
4.1 KiB
Markdown
Raw Normal View History

# Marlin 3D Printer Firmware
<img align="top" width=175 src="Documentation/Logo/Marlin%20Logo%20GitHub.png" />
2016-03-24 08:41:49 -05:00
Additional documentation can be found in [The Marlin Wiki](https://github.com/MarlinFirmware/Marlin/wiki/Main-Page).
2016-03-24 08:41:49 -05:00
## Release Candidate -- Marlin 1.1.0-RC4 - 24 March 2016
__Not for production use use with caution!__
2016-03-24 08:41:49 -05:00
You can download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases). (The latest "stable" release of Marlin is 1.0.2-1.)
2016-03-24 08:41:49 -05:00
You'll always find the latest Release Candidate in the ["RC" branch](https://github.com/MarlinFirmware/Marlin/tree/RC). Bugs that we find in the current Release Candidate are patched in the ["RCBugFix" branch](https://github.com/MarlinFirmware/Marlin/tree/RC), so during beta testing this is where you can always find the latest code on its way towards release.
2016-03-24 08:41:49 -05:00
Future development (Marlin 1.2 and beyond) takes place in the [MarlinDev repository](https://github.com/MarlinFirmware/MarlinDev/).
## Recent Changes
2016-03-24 09:47:59 -05:00
- RC4 - 24 Mar 2016
- Many lingering bugs and nagging issues addressed
- Improvements to LCD menus, CoreXY/CoreXZ, Delta, Bed Leveling, and more…
2016-03-24 08:41:49 -05:00
2016-03-24 09:47:59 -05:00
- 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
2016-03-24 09:47:59 -05:00
- RC2 - 29 Sep 2015
- File styling reverted
- LCD update frequency reduced
2016-03-24 09:47:59 -05:00
- RC1 - 19 Sep 2015
- Published for testing
## Submitting Patches
2016-03-24 08:41:49 -05:00
Proposed patches should be submitted as a Pull Request against the [RCBugFix](https://github.com/MarlinFirmware/Marlin/tree/RCBugFix) branch.
2016-03-24 08:41:49 -05:00
- Don't submit new feature proposals. The RCBugFix branch is for fixing bugs in existing features.
- Do submit questions and concerns. The "naive" question is often the one we forget to ask.
- Follow the proper coding style. Pull requests with styling errors will be delayed. See our [Coding Standards](https://github.com/MarlinFirmware/Marlin/wiki/DNE-Coding-Standards) page for more information.
2015-05-09 07:59:48 -05:00
## Current Status: Testing
2015-05-09 07:59:48 -05:00
2016-03-24 08:41:49 -05:00
Please test this firmware and inform us if it misbehaves in any way. Volunteers are standing by!
2015-05-09 07:59:48 -05: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 07:59:48 -05:00
##### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
2015-01-08 12:48:56 -06:00
## Credits
2015-01-08 12:54:46 -06:00
The current Marlin dev team consists of:
- Scott Lahteine [@thinkyhead] - English
2015-07-30 07:49:28 -05:00
- [@Wurstnase] - Deutsch, English
- F. Malpartida [@fmalpartida] - English, Spanish
2015-07-30 07:49:28 -05:00
- [@CONSULitAS] - Deutsch, English
2015-05-14 06:40:07 -05:00
- [@maverikou]
- Chris Palmer [@nophead]
- [@paclema]
- Edward Patel [@epatel] - Swedish, English
2015-05-14 20:21:53 -05:00
- Erik van der Zalm [@ErikZalm]
- David Braam [@daid]
- Bernhard Kubicek [@bkubicek]
2015-09-02 21:38:23 -05:00
- Roxanne Neufeld [@Roxy-3DPrintBoard] - English
2015-03-05 22:02:28 -06:00
2015-01-08 12:54:46 -06:00
More features have been added by:
- Alberto Cotronei [@MagoKimbra]
2015-01-08 12:54:46 -06:00
- Lampmaker,
- Bradley Feldman,
- and others...
2015-01-08 12:48:56 -06:00
2015-03-05 22:02:28 -06: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)