From 4764710b1167f056ac3bbd72ffdc9eaf459d1fcc Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Wed, 11 Oct 2017 18:10:15 -0500 Subject: [PATCH] Add a README.h file for Arduino IDE users --- Marlin/Marlin.ino | 8 ------- Marlin/README.h | 53 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 8 deletions(-) create mode 100644 Marlin/README.h diff --git a/Marlin/Marlin.ino b/Marlin/Marlin.ino index 9dd3f69077..e5b917e681 100644 --- a/Marlin/Marlin.ino +++ b/Marlin/Marlin.ino @@ -20,14 +20,6 @@ * */ -/** - * About Marlin - * - * This firmware is a mashup between Sprinter and grbl. - * - https://github.com/kliment/Sprinter - * - https://github.com/simen/grbl/tree - */ - #include "src/inc/MarlinConfig.h" #if ENABLED(ULTRA_LCD) diff --git a/Marlin/README.h b/Marlin/README.h new file mode 100644 index 0000000000..c8a8231fb2 --- /dev/null +++ b/Marlin/README.h @@ -0,0 +1,53 @@ +/* +================================================================================ + + Marlin Firmware + + (c) 2011-2017 MarlinFirmware + Portions of Marlin are (c) by their respective authors. + All code complies with GPLv2 and/or GPLv3 + +================================================================================ + +Greetings! Thank you for choosing Marlin 2 as your 3D printer firmware. + +To configure Marlin you must edit Configuration.h and Configuration_adv.h +located in the root 'Marlin' folder. Check the config/examples folder to see if +there's a more suitable starting-point for your specific hardware. + +Before diving in, we recommend the following essential links: + +Marlin Firmware Official Website + + - http://marlinfw.org/ + The official Marlin Firmware website contains the most up-to-date + documentation. Contributions are always welcome! + +Configuration + + - https://www.youtube.com/watch?v=3gwWVFtdg-4 + A good 20-minute overview of Marlin configuration by Tom Sanladerer. + (Applies to Marlin 1.0.x, so Jerk and Acceleration should be halved.) + Also... https://www.google.com/search?tbs=vid%3A1&q=configure+marlin + + - http://marlinfw.org/docs/configuration/configuration.html + Marlin's configuration options are explained in more detail here. + +Getting Help + + - http://forums.reprap.org/list.php?415 + The Marlin Discussion Forum is a great place to get help from other Marlin + users who may have experienced similar issues to your own. + + - https://github.com/MarlinFirmware/Marlin/issues + With a free GitHub account you can provide us with feedback, bug reports, + and feature requests via the Marlin Issue Queue. + +Contributing + + - http://marlinfw.org/docs/development/contributing.html + If you'd like to contribute to Marlin, read this first! + + - http://marlinfw.org/docs/development/coding_standards.html + Before submitting code get to know the Coding Standards. +*/ \ No newline at end of file