blob: c248b43170c62fcf99d14eb75fe6a9f018f3d3c4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
---
title: Installing Marlin
description: Marlin Install Quick Start Guide
author: thinkyhead
contrib: bob-the-kuhn
category: [ articles, getting-started ]
---
To install Marlin on your printer you'll first need to Download Marlin, then edit your Configuration files, and finally use an IDE to [Compile](//en.wikipedia.org/wiki/Compiler){:target="_blank"} the Marlin project into a binary form and [Upload](//www.arduino.cc/en/Guide/Environment#toc9){:target="_blank"} it to your board. The build process can seem daunting at first, but after you do it a few times you'll be a pro.
{% alert info %}
Marlin only needs to be re-flashed when fixed settings are changed in the configuration files. Many settings are only defaults and can be changed (and saved to EEPROM) with G-codes. See each option's description in the configuration files to find out which G-codes apply.
{% endalert %}
### Download
Start by downloading the Marlin source code. There are a few [codebases](//en.wikipedia.org/wiki/Codebase) to choose from.
----|-----------
[Download 2.1](//github.com/MarlinFirmware/Marlin/archive/2.1.zip)|Current release
[Download 2.1.x](//github.com/MarlinFirmware/Marlin/archive/2.1.x.zip)|Current release, patched
[Download bugfix-2.1.x](//github.com/MarlinFirmware/Marlin/archive/bugfix-2.1.x.zip)|"Nightly" build for Marlin 2.1.x _Proceed with Caution!_
[Download 2.0.9.5](//github.com/MarlinFirmware/Marlin/archive/2.0.9.5.zip)|Previous release
[Download 2.0.x](//github.com/MarlinFirmware/Marlin/archive/2.0.x.zip)|Previous release, patched
[Download bugfix-2.0.x](//github.com/MarlinFirmware/Marlin/archive/bugfix-2.0.x.zip)|"Nightly" build for Marlin 2.0.x _Proceed with Caution!_
[Download 1.1.x](//github.com/MarlinFirmware/Marlin/archive/1.1.x.zip)|Legacy Marlin 1.1
[Download bugfix-1.1.x](//github.com/MarlinFirmware/Marlin/archive/bugfix-1.1.x.zip)|"Nightly" build. _Proceed with Caution!_
[Download 1.0.x](//github.com/MarlinFirmware/Marlin/archive/1.0.x.zip)|Legacy Marlin 1.0
{% alert warning %}
- Marlin 1.0 **does not support PlatformIO**. For older versions of Marlin use Arduino IDE.
- Marlin 1.1 **fully supports PlatformIO**, and Marlin 1.1.9 even provides an automated build process.
- Marlin 2.0 and up include 32-bit ARM support. **PlatformIO is not required for AVR boards.**
{% endalert %}
### Configure
To configure Marlin you can use the Arduino IDE or your [favorite text editor](//www.sublimetext.com/){:target="_blank"} to edit the `Configuration.h` and `Configuration_adv.h` files. See [Configuring Marlin](/docs/configuration/configuration.html) for full details.
### Build and Install
Marlin installation procedure can vary depending on which version of Marlin you want to install and which board you're installing onto. Once your Marlin build environment is set up installing updates can be a one-click operation.
Marlin Version|Platform(s)|Instructions
--------------|-----------|----
1.1.x or 2.x|8-bit AVR|[Install Marlin with Arduino IDE](install_arduino.html)
1.1.9 or 2.x|8-bit AVR, 32-bit ARM|[Install Marlin with PlatformIO](install_platformio.html)
2.x|LPC1768 (Re-Arm)|[Install Marlin on Re-ARM](install_rearm.html)
{% alert info %}
Looking for Example Configurations for your machine?
- Marlin 1.1.x : Included in the '`example_configurations`' folder.
- Marlin 2.x.x : [Hosted separately](//github.com/MarlinFirmware/Configurations). Links on the [Downloads](/meta/download/) page.
{% endalert %}
### Troubleshooting
Troubleshooting a complex piece of software with a minimal interface can sometimes be challenging, even for the most experienced 3D printing enthusiast. Please use our [Troubleshooting Guide](troubleshooting.html) for tips on some common problems.
|
