Subversion Repositories Tronxy-X3A-Marlin

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
1 ron 1 
# Auto Build support for Visual Studio Code
2 
This `Visual Studio Code` extension provides access to the `Auto Build` script.
3 
 
4 
## Installation
5 
 
6 
Get the MarlinFirmware repository from GitHub. Open the directory `buildroot/share/vscode` and copy the `AutoBuildMarlin` folder to the `Visual Studio Code` extension directory. Relaunch `Visual Studio Code` to complete the installation.
7 
 
8 
To find the `Visual Studio Code` extension directory:
9 
 
10 
- Windows - Use Windows Explorer's address bar to open `C:/Users/USERNAME/.vscode/extensions`.
11 
- Mac - Use the Finder's `Go` menu to open `~/.vscode/extensions`.
12 
- Linux - In the Terminal type `open ~/.vscode/extensions`.
13 
 
14 
### 3. Install the PlatformIO extension
15 
Click on `View` > `Command Palette...`
16 
 
17 
![](./resources/view_command_palette.png)
18 
 
19 
Find and click on `Extensions: Install Extensions`
20 
 
21 
![](./resources/install_extensions.png)
22 
 
23 
Type `platformio` into the search box and click on `Install` under `PlatformIO IDE`.
24 
 
25 
![](./resources/platformio_install.png)
26 
 
27 
## Usage
28 
 
29 
This extension adds the Auto Build icon ![](./media/AB.svg) to the Activities bar.
30 
 
31 
### 1. Open the Marlin folder
32 
Click on `File` > `Open Folder...`
33 
 
34 
![](./resources/Open_Folder.png)
35 
 
36 
This brings up the `Open Folder` dialog. Select the folder that has the `platformio.ini` file in it.
37 
 
38 
![](./resources/Open_Marlin.png)
39 
 
40 
You should see something like the following. If not, click on the Explorer icon in the Activities bar.
41 
 
42 
![](./resources/Activity_bar.png)
43 
 
44 
### 2. Click on the Auto Build Icon ![](./media/AB.svg)
45 
This brings up the Auto Build menu icon bar.
46 
![](./resources/AB_menu.png)
47 
 
48 
### 3. Click on one of the four icons
49 
- ![](./resources/B_small.svg) - Clicking on it starts `PIO Build`
50 
- ![](./resources/C_small.svg) - Clicking on it starts `PIO Clean`
51 
- ![](./resources/U_small.svg) - Clicking on it starts `PIO Upload`
52 
- ![](./resources/Ut_small.svg) - Clicking on it starts `PIO Upload (traceback)`