Skip to content

Commit 0ebfe5d

Browse files
improve archive structure docs
1 parent 15a5e88 commit 0ebfe5d

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

Diff for: docs/package_index_json-specification.md

+38-2
Original file line numberDiff line numberDiff line change
@@ -369,12 +369,48 @@ versions of the `PACKAGE`, 1.0.0 and 1.0.1. No `TOOLS` needed to be installed so
369369

370370
Here is the Boards Manager entry created by the example: ![Boards Manager screenshot](img/boards-manager-screenshot.png)
371371

372-
## Installation archive structure
372+
## Archive structure
373+
374+
It must contain a single folder in the root. All files and `__MACOSX` folder present in the root will be ignored.
375+
376+
Valid structure
377+
378+
```
379+
.
380+
└── avr/
381+
├── bootloaders
382+
├── cores
383+
├── firmwares
384+
├── libraries
385+
├── variants
386+
├── boards.txt
387+
├── platform.txt
388+
└── programmers.txt
389+
```
390+
391+
Invalid structure:
392+
393+
```
394+
.
395+
├── avr/
396+
│ ├── ...
397+
│ ├── boards.txt
398+
│ ├── platform.txt
399+
│ └── programmers.txt
400+
├── folder2
401+
└── folder3
402+
```
403+
404+
**Note**: the folder structure of the core archive is slightly different from the standard manually installed Arduino
405+
IDE 1.5+ compatible hardware folder structure. You must remove the architecture folder(e.g., `avr` or `arm`), moving all
406+
the files and folders within the architecture folder up a level.
407+
408+
### Installation
373409

374410
The installation archives contain the Board support files.
375411

376412
Supported formats are `.zip`, `.tar.bz2`, and `.tar.gz`. Starting from Arduino CLI >=0.30.0 support for `.tar.xz`, and
377-
`.tar.zst` has been added, by the way, if you want to keep compatiblity with older versions of Arduino IDE and Arduino
413+
`.tar.zst` has been added, by the way, if you want to keep compatibility with older versions of Arduino IDE and Arduino
378414
CLI we recommend using one of the older formats.
379415

380416
The folder structure of the core archive is slightly different from the standard manually installed Arduino IDE 1.5+

0 commit comments

Comments
 (0)