Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "Add boards to Arduino IDE" / "Uninstall boards from Arduino IDE" [HC-1606] #439

Merged
merged 3 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions content/Software Support/Installation/Add-boards-to-Arduino-IDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,56 +5,51 @@ id: 360016119519

A **board core** (or just _board_ for short) is a collection of files needed to compile and upload sketches for a board. Cores are contained in _packages_ and can be installed using the Board Manager.

---
In this article:

- [Add a board with the Boards Manager](#add_board)
- [Add additional packages to the Boards Manager](#additional_packages)
- [Install a board manually](#board_manually)

<a id="add-with-board-manager"></a>
---

## Add a board with the Boards Manager
## Add a board with the Boards Manager{#add_board}

Official Arduino cores can be conveniently installed with the Boards Manager tool.

1. In the menu bar, select _Tools > Board > Boards Manager_. In IDE 2 you can also access it by clicking the button in the left-most sidebar.
1. In the menu bar, select _Tools > Board > Boards Manager..._ ,or click on the ![Boards Manager icon](img/symbol_board.png) button in the sidebar.

2. Either search for the package name (e.g. "megaAVR"), or the board (e.g. "Uno", "MKR1000", or "Portenta"), by typing in the search field.

3. Find the package that includes your board.

4. Click **Install** (the latest version is selected by default).

> [!NOTE]
> If the package is already installed, you will instead have the option of installing a different version.

5. Wait for the installation to complete.

<div>
<figure style="display: inline-block; margin: 0;">
<img src="img/board-manager-install-ide1.png" alt="Searching for 'Nano Every' and installing the resulting megaAVR Boards package in Board Manager in IDE 1.x."/>
<figcaption><i>Boards Manager in Arduino IDE 1.x.</i></figcaption>
</figure>
<figure style="display: inline-block; margin: 0;">
<img src="img/board-manager-install-ide2.png" alt="Searching for 'Nano Every' and installing the resulting megaAVR Boards package in Board Manager in IDE 2."/>
<figcaption style><i>Boards Manager in Arduino IDE 2.</i></figcaption>
</figure>
</div>
![Board Manager](img/board-manager-install-ide2.png)

You can now select boards from the installed packages in the _Tools > Board_ menu:

![Selecting Arduino Nano Every from the megaAVR package in Arduino IDE.](img/ide_menu_tools_board_megaAVR_nano_every.png)

---

## Add additional packages to the Boards Manager
## Add additional packages to the Boards Manager{#additional_packages}

See [Add or remove third-party boards in Boards Manager](https://support.arduino.cc/hc/en-us/articles/360016466340-Add-or-remove-third-party-boards-in-Boards-Manager).

---

## Install a board manually
## Install a board manually{#board_manually}

Cores can also be added directly to the file system. See [Find sketches, libraries, board cores, and other files on your computer](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer#boards).

---

## Further reading

* [Add or remove third-party boards in Boards Manager](https://support.arduino.cc/hc/en-us/articles/360016466340-Add-or-remove-third-party-boards-in-Boards-Manager)
* [Uninstall boards using the Boards Manager](https://support.arduino.cc/hc/en-us/articles/4407225360018-Uninstall-boards-using-the-Boards-Manager)
[Uninstall boards using the Boards Manager](https://support.arduino.cc/hc/en-us/articles/4407225360018-Uninstall-boards-using-the-Boards-Manager)
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,34 @@ id: 4407225360018

The Boards Manager provides the most convenient way to remove unwanted or unused boards. The location of the installed cores can be found [here](https://support.arduino.cc/hc/en-us/articles/4415103213714#boards).

The following instructions to uninstall is not limited to the core in this example; it equally would be applicable to both official Arduino and third party cores.
The following instructions to uninstall are not limited to the core in this example; they are equally applicable to both official Arduino and third-party cores.

---
In this article:

- [Uninstall using the Boards Manager](#uninstall_board)
- [Uninstall by directly deleting files](#delete_files)

## Uninstall using the Boards Manager
---

> [!NOTE]
> In Arduino IDE 1.x, the "Arduino AVR Boards" package is bundled with [the application files](https://support.arduino.cc/hc/en-us/articles/4412943340178-Open-the-Arduino-IDE-installation-folder) and cannot be uninstalled using the Boards Manager.
## Uninstall using the Boards Manager{#uninstall_board}

The Boards Manager provides the most convenient way to remove unwanted or unused boards.

1. **Open the Boards Manager:**

* In the menu bar, select _Tools > Board > Boards Manager..._
* In IDE 2, you can also click on the ![Boards Manager icon](img/symbol_board.png) button in the sidebar.
1. In the menu bar, select *Tools > Board > Boards Manager...*, or click on the ![Boards Manager icon](img/symbol_board.png) button in the sidebar.

2. Filter the results by typing in the text field, and find the board package you want to uninstall.

3. **Uninstall the library:**
3. Click the **Remove** button.

* In Arduino IDE 1.x, click the **Remove** button.
![Uninstalling AVR Boards package.](img/uninstall-board.png)

* In Arduino IDE 2, hover over the "Installed" label to reveal the **Uninstall** button, and click it.

![Uninstalling the SAMD package in Arduino IDE 1 and IDE 2.](img/uninstall-board.png)
_The Library Manager looks slightly different depending on what version of the IDE you are using._

4. Confirm that you want to uninstall the board package.
4. Confirm that you want to uninstall the library by clicking **Yes**.

5. Wait while Arduino IDE uninstalls the board package.

If you want to remove many packages, or are unsure which packages are installed, it will be more efficient to [delete the files directly](#delete-files).

---

<a id="delete-files"></a>

## Uninstall by directly deleting files
## Uninstall by directly deleting files{#delete_files}

The files can also be removed directly with your system's file manager application:

Expand All @@ -60,4 +50,4 @@ The files can also be removed directly with your system's file manager applicati

## Further reading

* [Add boards to Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519)
- [Add boards to Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519)
Binary file modified content/Software Support/Installation/img/uninstall-board.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.