Browse Source

Format README.md with subsections

Having actual section headers instead of just bold text makes those parts of the document individually linkable.
Dan Lipsitt 11 years ago
parent
commit
5bf73b86ff
1 changed files with 26 additions and 12 deletions
  1. 26
    12
      README.md

+ 26
- 12
README.md View File

19
 
19
 
20
 
20
 
21
 Features:
21
 Features:
22
+=========
22
 
23
 
23
 *   Interrupt based movement with real linear acceleration
24
 *   Interrupt based movement with real linear acceleration
24
 *   High steprate
25
 *   High steprate
56
 Differences and additions to the already good Sprinter firmware:
57
 Differences and additions to the already good Sprinter firmware:
57
 ================================================================
58
 ================================================================
58
 
59
 
59
-*Look-ahead:*
60
+Look-ahead:
61
+-----------
60
 
62
 
61
 Marlin has look-ahead. While sprinter has to break and re-accelerate at each corner,
63
 Marlin has look-ahead. While sprinter has to break and re-accelerate at each corner,
62
 lookahead will only decelerate and accelerate to a velocity,
64
 lookahead will only decelerate and accelerate to a velocity,
64
 This is only possible, if some future moves are already processed, hence the name.
66
 This is only possible, if some future moves are already processed, hence the name.
65
 It leads to less over-deposition at corners, especially at flat angles.
67
 It leads to less over-deposition at corners, especially at flat angles.
66
 
68
 
67
-*Arc support:*
69
+Arc support:
70
+------------
68
 
71
 
69
 Slic3r can find curves that, although broken into segments, were ment to describe an arc.
72
 Slic3r can find curves that, although broken into segments, were ment to describe an arc.
70
 Marlin is able to print those arcs. The advantage is the firmware can choose the resolution,
73
 Marlin is able to print those arcs. The advantage is the firmware can choose the resolution,
71
 and can perform the arc with nearly constant velocity, resulting in a nice finish.
74
 and can perform the arc with nearly constant velocity, resulting in a nice finish.
72
 Also, less serial communication is needed.
75
 Also, less serial communication is needed.
73
 
76
 
74
-*Temperature Oversampling:*
77
+Temperature Oversampling:
78
+-------------------------
75
 
79
 
76
 To reduce noise and make the PID-differential term more useful, 16 ADC conversion results are averaged.
80
 To reduce noise and make the PID-differential term more useful, 16 ADC conversion results are averaged.
77
 
81
 
78
-*AutoTemp:*
82
+AutoTemp:
83
+---------
79
 
84
 
80
 If your gcode contains a wide spread of extruder velocities, or you realtime change the building speed, the temperature should be changed accordingly.
85
 If your gcode contains a wide spread of extruder velocities, or you realtime change the building speed, the temperature should be changed accordingly.
81
 Usually, higher speed requires higher temperature.
86
 Usually, higher speed requires higher temperature.
88
 If the target temperature is set manually or by gcode to a value less then tempmin, it will be kept without change.
93
 If the target temperature is set manually or by gcode to a value less then tempmin, it will be kept without change.
89
 Ideally, your gcode can be completely free of temperature controls, apart from a M109 S T F in the start.gcode, and a M109 S0 in the end.gcode.
94
 Ideally, your gcode can be completely free of temperature controls, apart from a M109 S T F in the start.gcode, and a M109 S0 in the end.gcode.
90
 
95
 
91
-*EEPROM:*
96
+EEPROM:
97
+-------
92
 
98
 
93
 If you know your PID values, the acceleration and max-velocities of your unique machine, you can set them, and finally store them in the EEPROM.
99
 If you know your PID values, the acceleration and max-velocities of your unique machine, you can set them, and finally store them in the EEPROM.
94
 After each reboot, it will magically load them from EEPROM, independent what your Configuration.h says.
100
 After each reboot, it will magically load them from EEPROM, independent what your Configuration.h says.
95
 
101
 
96
-*LCD Menu:*
102
+LCD Menu:
103
+---------
97
 
104
 
98
 If your hardware supports it, you can build yourself a LCD-CardReader+Click+encoder combination. It will enable you to realtime tune temperatures,
105
 If your hardware supports it, you can build yourself a LCD-CardReader+Click+encoder combination. It will enable you to realtime tune temperatures,
99
 accelerations, velocities, flow rates, select and print files from the SD card, preheat, disable the steppers, and do other fancy stuff.
106
 accelerations, velocities, flow rates, select and print files from the SD card, preheat, disable the steppers, and do other fancy stuff.
100
 One working hardware is documented here: http://www.thingiverse.com/thing:12663
107
 One working hardware is documented here: http://www.thingiverse.com/thing:12663
101
 Also, with just a 20x4 or 16x2 display, useful data is shown.
108
 Also, with just a 20x4 or 16x2 display, useful data is shown.
102
 
109
 
103
-*SD card folders:*
110
+SD card folders:
111
+----------------
104
 
112
 
105
 If you have an SD card reader attached to your controller, also folders work now. Listing the files in pronterface will show "/path/subpath/file.g".
113
 If you have an SD card reader attached to your controller, also folders work now. Listing the files in pronterface will show "/path/subpath/file.g".
106
 You can write to file in a subfolder by specifying a similar text using small letters in the path.
114
 You can write to file in a subfolder by specifying a similar text using small letters in the path.
107
 Also, backup copies of various operating systems are hidden, as well as files not ending with ".g".
115
 Also, backup copies of various operating systems are hidden, as well as files not ending with ".g".
108
 
116
 
109
-*SD card folders:*
117
+SD card folders:
118
+----------------
110
 
119
 
111
 If you place a file auto[0-9].g into the root of the sd card, it will be automatically executed if you boot the printer. The same file will be executed by selecting "Autostart" from the menu.
120
 If you place a file auto[0-9].g into the root of the sd card, it will be automatically executed if you boot the printer. The same file will be executed by selecting "Autostart" from the menu.
112
 First *0 will be performed, than *1 and so on. That way, you can heat up or even print automatically without user interaction.
121
 First *0 will be performed, than *1 and so on. That way, you can heat up or even print automatically without user interaction.
113
 
122
 
114
-*Endstop trigger reporting:*
123
+Endstop trigger reporting:
124
+--------------------------
115
 
125
 
116
 If an endstop is hit while moving towards the endstop, the location at which the firmware thinks that the endstop was triggered is outputed on the serial port.
126
 If an endstop is hit while moving towards the endstop, the location at which the firmware thinks that the endstop was triggered is outputed on the serial port.
117
 This is useful, because the user gets a warning message.
127
 This is useful, because the user gets a warning message.
118
 However, also tools like QTMarlin can use this for finding acceptable combinations of velocity+acceleration.
128
 However, also tools like QTMarlin can use this for finding acceptable combinations of velocity+acceleration.
119
 
129
 
120
-*Coding paradigm:*
130
+Coding paradigm:
131
+----------------
121
 
132
 
122
 Not relevant from a user side, but Marlin was split into thematic junks, and has tried to partially enforced private variables.
133
 Not relevant from a user side, but Marlin was split into thematic junks, and has tried to partially enforced private variables.
123
 This is intended to make it clearer, what interacts which what, and leads to a higher level of modularization.
134
 This is intended to make it clearer, what interacts which what, and leads to a higher level of modularization.
127
 some transfer is information (usually beginning with "echo:"), an error "error:", or just normal protocol,
138
 some transfer is information (usually beginning with "echo:"), an error "error:", or just normal protocol,
128
 necessary for backwards compatibility.
139
 necessary for backwards compatibility.
129
 
140
 
130
-*Interrupt based temperature measurements:*
141
+Interrupt based temperature measurements:
142
+-----------------------------------------
131
 
143
 
132
 An interrupt is used to manage ADC conversions, and enforce checking for critical temperatures.
144
 An interrupt is used to manage ADC conversions, and enforce checking for critical temperatures.
133
 This leads to less blocking in the heater management routine.
145
 This leads to less blocking in the heater management routine.
276
 The second tells what axis this servo will be attached to. In the example above, we have a servo in Z axis.
288
 The second tells what axis this servo will be attached to. In the example above, we have a servo in Z axis.
277
 The third one tells the angle in 2 situations: Probing (165º) and resting (60º). Check this with command M280 P0 S{angle} (example: M280 P0 S60 moves the servo to 60º)
289
 The third one tells the angle in 2 situations: Probing (165º) and resting (60º). Check this with command M280 P0 S{angle} (example: M280 P0 S60 moves the servo to 60º)
278
 
290
 
279
-*For RAMPS users:*
291
+For RAMPS users:
292
+----------------
293
+
280
 By default, RAMPS have no power on servo bus (if you happen to have a multimeter, check the voltage on servo power pins).
294
 By default, RAMPS have no power on servo bus (if you happen to have a multimeter, check the voltage on servo power pins).
281
 In order to get the servo working, you need to supply 5V to 5V pin.. You can do it using your power supply (if it has a 5V output) or jumping the "Vcc" from Arduino to the 5V RAMPS rail.
295
 In order to get the servo working, you need to supply 5V to 5V pin.. You can do it using your power supply (if it has a 5V output) or jumping the "Vcc" from Arduino to the 5V RAMPS rail.
282
 These 2 pins are located just between the Reset Button and the yellow fuses... There are marks in the board showing 5V and VCC.. just connect them..
296
 These 2 pins are located just between the Reset Button and the yellow fuses... There are marks in the board showing 5V and VCC.. just connect them..

Loading…
Cancel
Save