marlin/buildroot/share/vscode/AutoBuildMarlin/README.md

Auto Build Marlin

“AutoBuildMarlin” is a Visual Studio Code extension that provides a one-button interface to build and upload Marlin Firmware to your selected MOTHERBOARD, removing the need to edit your platformio.ini file or scroll through a long list of Marlin environments.

Get PlatformIO

Before you install AutoBuildMarlin you’ll first need to Install PlatformIO in VSCode. Once you have followed these instructions, continue below.

Installing This Extension

• Download Marlin Firmware and unzip it to your documents folder.
• Open the directory buildroot/share/vscode and copy the “AutoBuildMarlin” folder to the Visual Studio Code extensions directory.
• Relaunch Visual Studio Code to complete the installation.

To find your extensions directory:

• Windows - Use Windows Explorer’s address bar to open C:/Users/USERNAME/.vscode/extensions.
• Mac - Use the Finder’s Go menu to open ~/.vscode/extensions.
• Linux - In the Terminal type open ~/.vscode/extensions.

Usage

• Open up the downloaded Marlin Firmware project folder (NOT the “Marlin” folder within) in Visual Studio Code. (You may also use the Import Project… option from the “PlaformIO Home” page.)

• With Marlin open, the “File Explorer” should be firmly rooted in your Marlin Firmware folder:

• Click the Marlin Auto Build icon in the Activities Bar (on the left side of Visual Studio Code window) to bring up the Marlin Auto Build options bar.

• Click one of the four icons

Icon	Action
	Start Marlin Build to test your Marlin build
	Start Marlin Upload to install Marlin on your board
	Start Marlin Upload (traceback) to install Marlin with debugging
	Start Marlin Clean to delete old build files