aboutsummaryrefslogtreecommitdiff
path: root/Marlin/Marlin.ino
diff options
context:
space:
mode:
Diffstat (limited to 'Marlin/Marlin.ino')
-rw-r--r--Marlin/Marlin.ino57
1 files changed, 57 insertions, 0 deletions
diff --git a/Marlin/Marlin.ino b/Marlin/Marlin.ino
new file mode 100644
index 0000000..57c8254
--- /dev/null
+++ b/Marlin/Marlin.ino
@@ -0,0 +1,57 @@
+/*==============================================================================
+
+ Marlin Firmware
+
+ (c) 2011-2020 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 our Configurations repository 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
+
+ - https://marlinfw.org/
+ The official Marlin Firmware website contains the most up-to-date
+ documentation. Contributions are always welcome!
+
+Configuration
+
+ - https://github.com/MarlinFirmware/Configurations
+ Example configurations for several printer models.
+
+ - 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
+
+ - https://marlinfw.org/docs/configuration/configuration.html
+ Marlin's configuration options are explained in more detail here.
+
+Getting Help
+
+ - https://reprap.org/forum/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
+
+ - https://marlinfw.org/docs/development/contributing.html
+ If you'd like to contribute to Marlin, read this first!
+
+ - https://marlinfw.org/docs/development/coding_standards.html
+ Before submitting code get to know the Coding Standards.
+
+
+------------------------------------------------------------------------------*/