MPCNC/Firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Restore bugfix README, etc.

Browse Source
This commit is contained in:
Scott Lahteine 2018-08-07 13:45:03 -05:00
parent 614a944504
commit 332a80cadb
3 changed files with 44 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/contributing.md vendored
View File

@ -132,7 +132,7 @@ Pull Requests should always be targeted to working branches (e.g., `bugfix-1.1.x
* Use the present tense ("Add feature" not "Added feature"). * Use the present tense ("Add feature" not "Added feature").
* Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). * Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
* Limit the first line to 72 characters or less. * Limit the first line to 72 characters or fewer.
* Reference issues and Pull Requests liberally after the first line. * Reference issues and Pull Requests liberally after the first line.
### C++ Coding Standards ### C++ Coding Standards

2
Marlin/Version.h
View File

@ -35,7 +35,7 @@
/** /**
* Marlin release version identifier * Marlin release version identifier
*/ */
#define SHORT_BUILD_VERSION "1.1.9" #define SHORT_BUILD_VERSION "bugfix-1.1.x"
/** /**
* Verbose version identifier which should contain a reference to the location * Verbose version identifier which should contain a reference to the location

83
README.md
View File

@ -1,84 +1,85 @@
# Marlin 3D Printer Firmware # Marlin 3D Printer Firmware
<img align="right" src="../../raw/1.1.x/buildroot/share/pixmaps/logo/marlin-250.png" />
Marlin is an optimized firmware for [RepRap 3D printers](http://reprap.org/) based on the [Arduino](https://www.arduino.cc/) platform. First created in 2011 for RepRap and Ultimaker printers, today Marlin drives a majority of the world's most popular 3D printers. Marlin delivers outstanding print quality with unprecedented control over the process.
[![Build Status](https://travis-ci.org/MarlinFirmware/Marlin.svg?branch=RCBugFix)](https://travis-ci.org/MarlinFirmware/Marlin)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/2224/badge.svg)](https://scan.coverity.com/projects/2224) [![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)
[![Flattr Us!](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)
## Marlin 1.1.x <img align="top" width=175 src="buildroot/share/pixmaps/logo/marlin-250.png" />
The 1.1.x branch is home to all tagged releases of Marlin 1.1 (final version 1.1.9 – July 2018). Additional documentation can be found at the [Marlin Home Page](http://marlinfw.org/).
Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!
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. ## Bugfix Branch
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. __Not for production use. Use with caution!__
## Marlin 1.0.x This branch is used to accumulate patches to the latest 1.1.x release version. Periodically this branch will form the basis for the next minor 1.1.x release.
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. Download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases). (The latest tagged release of Marlin is version 1.1.7.)
## Contributing to Marlin ## Recent Changes
- Internally always use native machine space
- Initial UBL LCD Menu
- New optimized G-code parser singleton
- Initial `M3`/`M4`/`M5` Spindle and Laser support
- Added `M421 Q` to offset a mesh point
- Refinements to `G26` and `G33`
- Added `M80 S` to query the power state
- "Cancel Print" now shuts off heaters
- Added `EXTRAPOLATE_BEYOND_GRID` option for mesh-based leveling
If you have coding or writing skills you're encouraged to contribute to Marlin. You may also contribute suggestions, feature requests, and bug reports through the Marlin Issue Queue. ## Submitting Patches
Before contributing, please read our [Contributing Guidelines](https://github.com/MarlinFirmware/Marlin/blob/1.1.x/.github/contributing.md) and [Code of Conduct](https://github.com/MarlinFirmware/Marlin/blob/1.1.x/.github/code_of_conduct.md). Proposed patches should be submitted as a Pull Request against this branch ([bugfix-1.1.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-1.1.x)).
## Marlin Resources - This branch is for fixing bugs and integrating any new features for the duration of the Marlin 1.1.x life-cycle. We've opted for a simplified branch structure while we work on the maintainability and encapsulation of code modules. Version 2.0 and beyond should improve on separation of bug fixes and cutting-edge development.
- Follow the proper coding style to gain points with the maintainers. See our [Coding Standards](http://marlinfw.org/docs/development/coding_standards.html) page for more information.
- Please submit your questions and concerns to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues). The "naive" question is often the one we forget to ask.
- [Marlin Home Page](http://marlinfw.org/) - The latest Marlin documentation. ### [RepRap.org Wiki Page](http://reprap.org/wiki/Marlin)
- [Marlin Releases](https://github.com/MarlinFirmware/Marlin/releases) - All Marlin releases with release notes.
- [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) - Get help with configuration and troubleshooting.
- [Marlin Firmware Facebook group](https://www.facebook.com/groups/1049718498464482) - Help from the community. (Maintained by [@thinkyhead](https://github.com/thinkyhead).)
- [@MarlinFirmware](https://twitter.com/MarlinFirmware) on Twitter - Follow for news, release alerts, and tips. (Maintained by [@thinkyhead](https://github.com/thinkyhead).)
## Credits ## Credits
Marlin's administrators are: The current Marlin dev team consists of:
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)]
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)] - Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)]
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)]
- Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)] - Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)]
- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)]
Notable contributors include: Notable contributors include:
- Alexey Shvetsov [[@alexxy](https://github.com/alexxy)] - Alberto Cotronei [[@MagoKimbra](https://github.com/MagoKimbra)]
- Andreas Hardtung [[@AnHardt](https://github.com/AnHardt)] - Andreas Hardtung [[@AnHardt](https://github.com/AnHardt)]
- Ben Lye [[@benlye](https://github.com/benlye)]
- Bernhard Kubicek [[@bkubicek](https://github.com/bkubicek)] - Bernhard Kubicek [[@bkubicek](https://github.com/bkubicek)]
- Bob Cousins [[@bobc](https://github.com/bobc)] - Bob Cousins [[@bobc](https://github.com/bobc)]
- Petr Zahradnik [[@clexpert](https://github.com/clexpert)] - Chris Palmer [[@nophead](https://github.com/nophead)]
- Jochen Groppe [[@CONSULitAS](https://github.com/CONSULitAS)]
- David Braam [[@daid](https://github.com/daid)] - David Braam [[@daid](https://github.com/daid)]
- Eduardo José Tagle [[@ejtagle](https://github.com/ejtagle)]
- Ernesto Martinez [[@emartinez167](https://github.com/emartinez167)]
- Edward Patel [[@epatel](https://github.com/epatel)] - 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)] - F. Malpartida [[@fmalpartida](https://github.com/fmalpartida)]
- Jochen Groppe [[@CONSULitAS](https://github.com/CONSULitAS)]
- João Brazio [[@jbrazio](https://github.com/jbrazio)] - João Brazio [[@jbrazio](https://github.com/jbrazio)]
- Kai [[@Kaibob2](https://github.com/Kaibob2)] - Kai [[@Kaibob2](https://github.com/Kaibob2)]
- Luc Van Daele [[@LVD-AC](https://github.com/LVD-AC)] - Luc Van Daele[[@LVD-AC](https://github.com/LVD-AC)]
- Alberto Cotronei [[@MagoKimbra](https://github.com/MagoKimbra)]
- Marcio Teixeira [[@marcio-ao](https://github.com/marcio-ao)]
- Chris Palmer [[@nophead](https://github.com/nophead)]
- Chris Pepper [[@p3p](https://github.com/p3p)]
- Steeve Spaggi [[@studiodyne](https://github.com/studiodyne)]
- Thomas Moore [[@tcm0116](https://github.com/tcm0116)]
- Teemu Mäntykallio [[@teemuatlut](https://github.com/teemuatlut)]
- Nico Tonnhofer [[@Wurstnase](https://github.com/Wurstnase)] - Nico Tonnhofer [[@Wurstnase](https://github.com/Wurstnase)]
- Petr Zahradnik [[@clexpert](https://github.com/clexpert)]
- Thomas Moore [[@tcm0116](https://github.com/tcm0116)]
- [[@alexxy](https://github.com/alexxy)]
- [[@android444](https://github.com/android444)] - [[@android444](https://github.com/android444)]
- [[@benlye](https://github.com/benlye)]
- [[@bgort](https://github.com/bgort)] - [[@bgort](https://github.com/bgort)]
- [[@GMagician](https://github.com/GMagician)]
- [[@Grogyan](https://github.com/Grogyan)] - [[@Grogyan](https://github.com/Grogyan)]
- [[@marcio-ao](https://github.com/marcio-ao)]
- [[@maverikou](https://github.com/maverikou)] - [[@maverikou](https://github.com/maverikou)]
- [[@oysteinkrog](https://github.com/oysteinkrog)] - [[@oysteinkrog](https://github.com/oysteinkrog)]
- [[@p3p](https://github.com/p3p)]
- [[@paclema](https://github.com/paclema)] - [[@paclema](https://github.com/paclema)]
- [[@paulusjacobus](https://github.com/paulusjacobus)] - [[@paulusjacobus](https://github.com/paulusjacobus)]
- [[@psavva](https://github.com/psavva)] - [[@psavva](https://github.com/psavva)]
- [[@Tannoo](https://github.com/Tannoo)] - [[@Tannoo](https://github.com/Tannoo)]
- [[@TheSFReader](https://github.com/TheSFReader)] - [[@teemuatlut](https://github.com/teemuatlut)]
- ...and many others - ...and many others
## License ## License
Marlin is published under the [GPLv3 license](https://github.com/MarlinFirmware/Marlin/blob/1.0.x/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. 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.