mirror of
https://github.com/MarlinFirmware/Marlin.git
synced 2024-11-29 23:07:42 +00:00
Update README.md
This commit is contained in:
Scott Lahteine
parent
5cf6c44f47
commit
3a70028d5c
71
README.md
71
README.md
@ -1,68 +1,69 @@
|
||||
# Marlin 3D Printer Firmware
|
||||
<img align="right" src="../../raw/1.1.x/buildroot/share/pixmaps/logo/marlin-250.png" />
|
||||
|
||||
## Marlin 1.1
|
||||
Marlin is the world's most popular open source firmware for Replicating Rapid Prototyper (RepRap) machines, commonly referred to as "3D printers." Marlin Firmware is highly efficient, running even on modest 16MHz embedded AVR processors. While Marlin 1.1 only supports ATmega AVR (Arduino, etc.) and AT90USB (Teensy++ 2.0), [Marlin 2.0](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x) also adds support for several ARM processors, including the SAM3X8E (Arduino Due), NXP LPC1768/LPC1769 ARM Cortex-M3 (Re-Arm, MKS SBASE, Smoothieboard), and ARM Cortex-M4 (Teensy 3.5/3.6, STM32F1/4/7).
|
||||
|
||||
Marlin 1.1 represents an evolutionary leap over Marlin 1.0.2. It is the result of over two years of effort by several volunteers around the world who have paid meticulous and sometimes obsessive attention to every detail. For this release we focused on code quality, performance, stability, and overall user experience. Several new features have also been added, many of which require no extra hardware.
|
||||
A monumental amount of talent and effort goes into Marlin production, and thanks are due to many volunteers around the world. We work closely with the community, contributors, vendors, host and library developers, etc. to improve the quality, configurability, and compatibility of Marlin Firmware with a [huge variety](http://marlinfw.org/docs/configuration/configuration.html#motherboard) of boards. For the final 1.1 release we focused on code quality, performance, stability, and overall user experience. Several new features were added, many of which require no extra hardware.
|
||||
|
||||
For complete Marlin documentation click over to the [Marlin Homepage <marlinfw.org>](http://marlinfw.org/), where you will find in-depth articles, how-to videos, and tutorials on every aspect of Marlin, as the site develops. For release notes, see the [Releases](https://github.com/MarlinFirmware/Marlin/releases) page.
|
||||
## Documentation
|
||||
|
||||
The 1.1.x branch is home to all tagged releases of Marlin 1.1 (final version 1.1.9 – August 2018).
|
||||
- Visit [marlinfw.org](http://marlinfw.org/) for complete documentation on [configuration](http://marlinfw.org/docs/configuration/configuration.html), [installation](http://marlinfw.org/docs/basics/install.html), [features](http://marlinfw.org/meta/features/), and the many [G-codes](http://marlinfw.org/meta/gcode/) that Marlin supports. We will continue to expand the site to include in-depth articles, tutorials, and how-to videos on all of Marlin's features.
|
||||
- See the [Releases](https://github.com/MarlinFirmware/Marlin/releases) page for Release Notes on all current and previous versions of Marlin.
|
||||
- Check out the [RepRap.org Marlin Page](http://reprap.org/wiki/Marlin) for an overview of Marlin and its role in the RepRap project.
|
||||
|
||||
This branch will receive no further updates. All future development —including all bug fixes— will take place in the [`bugfix-2.0.x`](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x) branch, which will also serve as the root for all future Marlin development. Be sure to test [`bugfix-2.0.x`](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x) before reporting any bugs you find in 1.1.9.
|
||||
## Marlin 1.1.x
|
||||
|
||||
Marlin 1.1.9 is the final release of the 8-bit flat version of Marlin Firmware. A monumental amount of talent and effort has gone into its production, and thanks are due to many people around the world. Throughout Marlin 1.1 development we worked closely with the community, contributors, vendors, host developers, library developers, etc. to improve the quality, configurability, and compatibility of Marlin Firmware, all while continuing to support a wide variety of Arduino-based boards.
|
||||
The 1.1.x branch is home to all tagged releases of Marlin 1.1.
|
||||
|
||||
## Marlin 1.0.x
|
||||
Marlin 1.1.9 is the final release of the AVR-only flat version of Marlin Firmware, so there will be no further 1.1.x releases. However [`bugfix-1.1.x`](https://github.com/MarlinFirmware/Marlin/tree/bugfix-1.1.x) will continue to receive patches for critical bugs, so be sure to test it (or [`bugfix-2.0.x`](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) before reporting any bugs you find in 1.1.9.
|
||||
|
||||
Previous releases of Marlin include [1.0.2-2](https://github.com/MarlinFirmware/Marlin/tree/1.0.2-2) (December 2016) and [1.0.1](https://github.com/MarlinFirmware/Marlin/tree/1.0.1) (December 2014). Any version of Marlin prior to 1.0.1 (when we started tagging versions) can be collectively referred to as Marlin 1.0.0.
|
||||
## Marlin 2.0.x
|
||||
|
||||
[Marlin 2.0](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x) is the future, featuring a much-improved hierarchical file structure and full [32-bit support](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x) via a Hardware Access Layer (HAL). Marlin 2.0 continues to work with [Arduino IDE](https://www.arduino.cc/en/Main/Software) for the platforms it supports, and the excellent [PlatformIO IDE](https://platformio.org/platformio-ide) is recommended for the next generation of ARM-based boards. If you're looking for the very best that Marlin has to offer and aren't bothered by a few rough edges, give version 2.0 a try!
|
||||
|
||||
## Contributing to Marlin
|
||||
|
||||
Click on the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues) and [Pull Requests](https://github.com/MarlinFirmware/Marlin/pulls) links above at any time to see what we're currently working on.
|
||||
|
||||
To submit patches and new features for Marlin 1.1 check out the [bugfix-1.1.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-1.1.x) branch, add your commits, and submit a Pull Request back to the `bugfix-1.1.x` branch. Periodically that branch will form the basis for the next minor release.
|
||||
To submit patches and new features for Marlin 2.0 check out the [bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x) branch, add your commits, and submit a Pull Request back to the `bugfix-2.0.x` branch. Once 2.0.x has been certified for a critical mass of common 32-bit boards, it will become the next major release and will be the basis for all future major and minor releases.
|
||||
|
||||
Note that our "bugfix" branch will always contain the latest patches to the current release version. These patches may not be widely tested. As always, when using "nightly" builds of Marlin, proceed with full caution.
|
||||
|
||||
## Current Status: In Development
|
||||
|
||||
Marlin development has reached an important milestone with its first stable release in over 2 years. During this period we focused on cleaning up the code and making it more modern, consistent, readable, and sensible.
|
||||
|
||||
## Future Development
|
||||
|
||||
Marlin 1.1 is the last "flat" version of Marlin!
|
||||
|
||||
Arduino IDE now has support for folder hierarchies, so Marlin 1.2 will have a [hierarchical file structure](https://github.com/MarlinFirmware/Marlin/tree/breakup-marlin-idea). Marlin's newly reorganized code will be easier to work with and form a stronger starting-point as we get into [32-bit CPU support](https://github.com/MarlinFirmware/Marlin/tree/32-Bit-RCBugFix-new) and the Hardware Access Layer (HAL).
|
||||
|
||||
[](https://scan.coverity.com/projects/2224)
|
||||
[](https://travis-ci.org/MarlinFirmware/Marlin)
|
||||
Note that our "bugfix" branches always contain the latest patches and new code. These patches may not be widely tested. As always, when using "nightly" builds of Marlin, proceed with full caution.
|
||||
|
||||
## Marlin Resources
|
||||
|
||||
- [Marlin Home Page](http://marlinfw.org/) - The Marlin Documentation Project. Join us!
|
||||
- [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin) - An overview of Marlin and its role in RepRap.
|
||||
- [Marlin Firmware Forum](http://forums.reprap.org/list.php?415) - Find help with configuration, get up and running.
|
||||
- [Marlin Home Page](http://marlinfw.org/) - The Marlin Documentation Project. [Help us](https://github.com/MarlinFirmware/MarlinDocumentation) expand this site!
|
||||
- [@MarlinFirmware](https://twitter.com/MarlinFirmware) on Twitter - Follow for news, release alerts, and tips & tricks. (Maintained by [@thinkyhead](https://github.com/thinkyhead).)
|
||||
|
||||
## Marlin User Support
|
||||
|
||||
Looking for help? Our GitHub Issue Queue is only for development-related issues, feature requests, and bug reports. But there are several places where you can get help from experienced users:
|
||||
|
||||
- [RepRap.org Marlin Forum](http://forums.reprap.org/list.php?415)
|
||||
- ["Marlin Firmware" Facebook Group](https://www.facebook.com/groups/1049718498464482/)
|
||||
- [Tom's 3D Forums](https://discuss.toms3d.org/)
|
||||
- [Marlin on Discord](https://discord.gg/n5NJ59y)
|
||||
|
||||
## Credits
|
||||
|
||||
The current Marlin dev team consists of:
|
||||
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)]
|
||||
Marlin Admins:
|
||||
- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)]
|
||||
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)]
|
||||
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)]
|
||||
- Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)]
|
||||
|
||||
Notable contributors include:
|
||||
Notable contributors:
|
||||
- Alberto Cotronei [[@MagoKimbra](https://github.com/MagoKimbra)]
|
||||
- Andreas Hardtung [[@AnHardt](https://github.com/AnHardt)]
|
||||
- Bernhard Kubicek [[@bkubicek](https://github.com/bkubicek)]
|
||||
- Bob Cousins [[@bobc](https://github.com/bobc)]
|
||||
- Chris Palmer [[@nophead](https://github.com/nophead)]
|
||||
- Chris Pepper [[@p3p](https://github.com/p3p)]
|
||||
- David Braam [[@daid](https://github.com/daid)]
|
||||
- Éduardo Tagle [[@ejtagle](https://github.com/ejtagle)]
|
||||
- Edward Patel [[@epatel](https://github.com/epatel)]
|
||||
- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)]
|
||||
- Ernesto Martinez [[@emartinez167](https://github.com/emartinez167)]
|
||||
- F. Malpartida [[@fmalpartida](https://github.com/fmalpartida)]
|
||||
- Giuliano Zaro [[@GMagician](https://github.com/GMagician)]
|
||||
- Jochen Groppe [[@CONSULitAS](https://github.com/CONSULitAS)]
|
||||
- João Brazio [[@jbrazio](https://github.com/jbrazio)]
|
||||
- Kai [[@Kaibob2](https://github.com/Kaibob2)]
|
||||
@ -74,7 +75,6 @@ Notable contributors include:
|
||||
- [[@android444](https://github.com/android444)]
|
||||
- [[@benlye](https://github.com/benlye)]
|
||||
- [[@bgort](https://github.com/bgort)]
|
||||
- [[@ejtagle](https://github.com/ejtagle)]
|
||||
- [[@Grogyan](https://github.com/Grogyan)]
|
||||
- [[@marcio-ao](https://github.com/marcio-ao)]
|
||||
- [[@maverikou](https://github.com/maverikou)]
|
||||
@ -85,7 +85,7 @@ Notable contributors include:
|
||||
- [[@psavva](https://github.com/psavva)]
|
||||
- [[@Tannoo](https://github.com/Tannoo)]
|
||||
- [[@teemuatlut](https://github.com/teemuatlut)]
|
||||
- ...and many others
|
||||
- ...and you!
|
||||
|
||||
## License
|
||||
|
||||
@ -93,4 +93,9 @@ Marlin is published under the [GPL license](https://github.com/COPYING.md) becau
|
||||
|
||||
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.
|
||||
|
||||
[](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
|
||||
---
|
||||
|
||||
<!-- [](https://scan.coverity.com/projects/2224) -->
|
||||
- [](https://travis-ci.org/MarlinFirmware/Marlin)
|
||||
- [](https://flattr.com/submit/auto?user_id=thinkhead&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software) - Flattr Scott Lahteine
|
||||
- [](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software) - Flattr Erik van der Zalm
|
||||
|
||||
Loading…
Reference in New Issue
Block a user