Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.52 KB

INSTALL.md

File metadata and controls

48 lines (30 loc) · 2.52 KB

Installation Guide

There are several ways to install this extension to your VSCode, easiest one is from VSCode Marketplace. However if you are looking to contribute to this project we suggest you to have install in Source mode.

Marketplace Installation

Launch VSCode Quick Open (+P on Mac or Ctrl+P on Windows) and then paste the following command and press enter

ext install esp-idf-extension

Install from .vsix file

To install from .vsix file:

  1. Get vsix file
  1. Press F1 and type Install from VSIX and then select the downloaded .vsix file.

Build from Source Code

  • Install Node.js
  • Make sure have the C/C++ Extension from Visual Studio Code Marketplace.
  • Clone this repository git clone --recursive https://github.com/espressif/vscode-esp-idf-extension.git
  • Install all the dependencies, using yarn
  • Press F5 to Run with Debugger, this will launch a new VSCode Extension Development Host to debug the extension.
  • Build the Visual Studio Code extension setup with yarn package.

Configure the extension

  • (OPTIONAL) Press F1 and type ESP-IDF: Select where to save configuration settings, which can be User settings, Workspace settings or workspace folder settings. Please take a look at Working with multiple projects for more information. Default is User settings.
  • Please take a look at SETUP documentation or the Install tutorial for details about the extension configuration.

Uninstalling the plugin

  • In Visual Studio Code, go to the Extensions tab.
  • Click on the EspressifIDF extension lower right icon.
  • Click Uninstall.
  • Go to your ${VSCODE_EXTENSION_DIR} and make sure to delete the Espressif IDF plugin folder

${VSCODE_EXTENSION_DIR} is the location of the extension:

  • Windows: %USERPROFILE%\.vscode\extensions\espressif.esp-idf-extension-VERSION\
  • Linux & MacOSX: $HOME/.vscode/extensions/espressif.esp-idf-extension-VERSION/