Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit 1126581

Browse files
committed
update readme
1 parent 5571e52 commit 1126581

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,19 @@ Welcome to the Visual Studio Code extension for **Arduino** <sup>preview</sup> !
1616
* Integrated Arduino Debugging <sup>New</sup>
1717

1818
## Prerequisites
19-
The Arduino IDE is required. Please install it from the [download page](https://www.arduino.cc/en/main/software#download).
19+
Either the Arduino IDE or Arduino CLI are required.
20+
21+
### Arduino IDE
22+
The Arduino IDE can be installed the Arduino [download page](https://www.arduino.cc/en/main/software#download).
2023
- The supported Arduino IDE versions are `1.6.x` and later.
2124
- The Windows Store's version of the Arduino IDE is not supported because of the sandbox environment that the application runs in.
2225
- *Note:* Arduino IDE `1.8.7` has some breaking changes, causing board package and library installation failures.
2326

27+
### Arduino CLI
28+
The Arduino CLI can be downloaded from the repository's [release page](https://github.com/arduino/arduino-cli/releases/tag/0.13.0)
29+
- The extension has only been tested with v0.13.0.
30+
- If you use the CLI you will have to set `arduino.path` since the CLI does not have a defualt path.
31+
2432
## Installation
2533
Open VS Code and press <kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open command palette, select **Install Extension** and type `vscode-arduino`.
2634

@@ -48,7 +56,9 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
4856
- **Arduino: Select Serial Port**: Change the current serial port.
4957
- **Arduino: Send Text to Serial Port**: Send a line of text via the current serial port.
5058
- **Arduino: Upload**: Build sketch and upload to Arduino board.
59+
- **Arduino: CLI Upload**: Upload complied code without building sketch (CLI only).
5160
- **Arduino: Upload Using Programmer**: Upload using an external programmer.
61+
- **Arduino: CLI Upload Using Programmer**: Upload using an external programmer without building sketch (CLI only).
5262
- **Arduino: Verify**: Build sketch.
5363
- **Arduino: Rebuild IntelliSense Configuration**: Forced/manual rebuild of the IntelliSense configuration. The extension analyzes Arduino's build output and sets the Intellisense include paths, defines, compiler arguments accordingly.
5464

package.json

+2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@
3636
"*",
3737
"onCommand:arduino.verify",
3838
"onCommand:arduino.upload",
39+
"onCommand:arduino.cliUpload",
3940
"onCommand:arduino.uploadUsingProgrammer",
41+
"onCommand:arduiono.cliUploadUsingProgrammer",
4042
"onCommand:arduino.rebuildIntelliSenseConfig",
4143
"onCommand:arduino.selectProgrammer",
4244
"onCommand:arduino.selectSerialPort",

0 commit comments

Comments
 (0)