From 72346e80fa3370ecdbd68dc914d17a51782946c6 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Sun, 5 Jun 2022 23:56:18 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=96=20Repurpose=20as=20bugfix=20for=20?= =?UTF-8?q?2.0.9.4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Marlin/Version.h | 2 +- Marlin/src/inc/Version.h | 2 +- README.md | 28 ++++++++++++++++++++-------- config/README.md | 8 +++++++- 4 files changed, 29 insertions(+), 11 deletions(-) diff --git a/Marlin/Version.h b/Marlin/Version.h index 68d56f6e7e..32f3171712 100644 --- a/Marlin/Version.h +++ b/Marlin/Version.h @@ -28,7 +28,7 @@ /** * Marlin release version identifier */ -//#define SHORT_BUILD_VERSION "2.0.9.4" +//#define SHORT_BUILD_VERSION "bugfix-2.0.x" /** * Verbose version identifier which should contain a reference to the location diff --git a/Marlin/src/inc/Version.h b/Marlin/src/inc/Version.h index f7d5e1774c..8f36b24a57 100644 --- a/Marlin/src/inc/Version.h +++ b/Marlin/src/inc/Version.h @@ -25,7 +25,7 @@ * Release version. Leave the Marlin version or apply a custom scheme. */ #ifndef SHORT_BUILD_VERSION - #define SHORT_BUILD_VERSION "2.0.9.4" + #define SHORT_BUILD_VERSION "bugfix-2.0.x" #endif /** diff --git a/README.md b/README.md index e54c8f093a..84a600d257 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,14 @@ Additional documentation can be found at the [Marlin Home Page](https://marlinfw.org/). Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by! -## Marlin 2.0 +## Marlin 2.0 Bugfix Branch + +__Not for production use. Use with caution!__ Marlin 2.0 takes this popular RepRap firmware to the next level by adding support for much faster 32-bit and ARM-based boards while improving support for 8-bit AVR boards. Read about Marlin's decision to use a "Hardware Abstraction Layer" below. +This branch is for patches to the latest 2.0.x release version. Periodically this branch will form the basis for the next minor 2.0.x release. + Download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases). ## Example Configurations @@ -27,10 +31,11 @@ Before building Marlin you'll need to configure it for your specific hardware. Y ## Building Marlin 2.0 -To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](http://docs.platformio.org/en/latest/ide.html#platformio-ide). Detailed build and install instructions are posted at: +To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](https://docs.platformio.org/en/latest/ide.html#platformio-ide). We've posted detailed instructions on [Building Marlin with Arduino](https://marlinfw.org/docs/basics/install_arduino.html) and [Building Marlin with PlatformIO for ReArm](https://marlinfw.org/docs/basics/install_rearm.html) (which applies well to other 32-bit boards). - - [Installing Marlin (Arduino)](http://marlinfw.org/docs/basics/install_arduino.html) - - [Installing Marlin (VSCode)](http://marlinfw.org/docs/basics/install_platformio_vscode.html). +## Hardware Abstraction Layer (HAL) + +Marlin 2.0 introduces a layer of abstraction so that all the existing high-level code can be built for 32-bit platforms while still retaining full 8-bit AVR compatibility. Retaining AVR compatibility and a single code-base is important to us, because we want to make sure that features and patches get as much testing and attention as possible, and that all platforms always benefit from the latest improvements. ### Supported Platforms @@ -52,11 +57,18 @@ To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino [Teensy 4.1](https://www.pjrc.com/store/teensy41.html)|ARM® Cortex-M7| Linux Native|x86/ARM/etc.|Raspberry Pi -## Submitting Changes +## Submitting Patches -- Submit **Bug Fixes** as Pull Requests to the ([bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) branch. -- Follow the [Coding Standards](http://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers. -- Please submit your questions and concerns to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues). +Proposed patches should be submitted as a Pull Request against the ([bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) branch. + +- This branch is for fixing bugs and integrating any new features for the duration of the Marlin 2.0.x life-cycle. +- Follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers. +- Please submit Feature Requests and Bug Reports to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues/new/choose). Support resources are also listed there. +- Whenever you add new features, be sure to add tests to `buildroot/tests` and then run your tests locally, if possible. + - It's optional: Running all the tests on Windows might take a long time, and they will run anyway on GitHub. + - If you're running the tests on Linux (or on WSL with the code on a Linux volume) the speed is much faster. + - You can use `make tests-all-local` or `make tests-single-local TEST_TARGET=...`. + - If you prefer Docker you can use `make tests-all-local-docker` or `make tests-all-local-docker TEST_TARGET=...`. ## Marlin Support diff --git a/config/README.md b/config/README.md index 609b5d4c6f..4bd6ab851e 100644 --- a/config/README.md +++ b/config/README.md @@ -1,3 +1,9 @@ # Where have all the configurations gone? -## https://github.com/MarlinFirmware/Configurations/archive/release-2.0.9.4.zip +Marlin configurations for specific machines are now maintained in their own repository at: + +## https://github.com/MarlinFirmware/Configurations/tree/bugfix-2.0.x + +Configuration files for use with the nightly `bugfix-2.0.x` branch can be downloaded from: + +## https://github.com/MarlinFirmware/Configurations/archive/bugfix-2.0.x.zip