Procházet zdrojové kódy

Add a README.h file for Arduino IDE users

Scott Lahteine před 6 roky
rodič
revize
4764710b11
2 změnil soubory, kde provedl 53 přidání a 8 odebrání
  1. 0
    8
      Marlin/Marlin.ino
  2. 53
    0
      Marlin/README.h

+ 0
- 8
Marlin/Marlin.ino Zobrazit soubor

@@ -20,14 +20,6 @@
20 20
  *
21 21
  */
22 22
 
23
-/**
24
- * About Marlin
25
- *
26
- * This firmware is a mashup between Sprinter and grbl.
27
- *  - https://github.com/kliment/Sprinter
28
- *  - https://github.com/simen/grbl/tree
29
- */
30
-
31 23
 #include "src/inc/MarlinConfig.h"
32 24
 
33 25
 #if ENABLED(ULTRA_LCD)

+ 53
- 0
Marlin/README.h Zobrazit soubor

@@ -0,0 +1,53 @@
1
+/*
2
+================================================================================
3
+
4
+  Marlin Firmware
5
+
6
+  (c) 2011-2017 MarlinFirmware
7
+  Portions of Marlin are (c) by their respective authors.
8
+  All code complies with GPLv2 and/or GPLv3
9
+
10
+================================================================================
11
+
12
+Greetings! Thank you for choosing Marlin 2 as your 3D printer firmware.
13
+
14
+To configure Marlin you must edit Configuration.h and Configuration_adv.h
15
+located in the root 'Marlin' folder. Check the config/examples folder to see if
16
+there's a more suitable starting-point for your specific hardware.
17
+
18
+Before diving in, we recommend the following essential links:
19
+
20
+Marlin Firmware Official Website
21
+
22
+  - http://marlinfw.org/
23
+    The official Marlin Firmware website contains the most up-to-date
24
+    documentation. Contributions are always welcome!
25
+
26
+Configuration
27
+
28
+  - https://www.youtube.com/watch?v=3gwWVFtdg-4
29
+    A good 20-minute overview of Marlin configuration by Tom Sanladerer.
30
+    (Applies to Marlin 1.0.x, so Jerk and Acceleration should be halved.)
31
+    Also... https://www.google.com/search?tbs=vid%3A1&q=configure+marlin
32
+
33
+  - http://marlinfw.org/docs/configuration/configuration.html
34
+    Marlin's configuration options are explained in more detail here.
35
+
36
+Getting Help
37
+
38
+  - http://forums.reprap.org/list.php?415
39
+    The Marlin Discussion Forum is a great place to get help from other Marlin
40
+    users who may have experienced similar issues to your own.
41
+
42
+  - https://github.com/MarlinFirmware/Marlin/issues
43
+    With a free GitHub account you can provide us with feedback, bug reports,
44
+    and feature requests via the Marlin Issue Queue.
45
+
46
+Contributing
47
+
48
+  - http://marlinfw.org/docs/development/contributing.html
49
+    If you'd like to contribute to Marlin, read this first!
50
+
51
+  - http://marlinfw.org/docs/development/coding_standards.html
52
+    Before submitting code get to know the Coding Standards.
53
+*/

Loading…
Zrušit
Uložit