Skip to content

Commit 7e441f4

Browse files
improve archive structure docs
1 parent 15a5e88 commit 7e441f4

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

Diff for: docs/package_index_json-specification.md

+37-2
Original file line numberDiff line numberDiff line change
@@ -369,12 +369,47 @@ 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+
└── avr/
380+
├── bootloaders
381+
├── cores
382+
├── firmwares
383+
├── libraries
384+
├── variants
385+
├── boards.txt
386+
├── platform.txt
387+
└── programmers.txt
388+
```
389+
390+
Invalid structure:
391+
```
392+
.
393+
├── avr/
394+
│ ├── ...
395+
│ ├── boards.txt
396+
│ ├── platform.txt
397+
│ └── programmers.txt
398+
├── folder2
399+
└── folder3
400+
```
401+
402+
**Note**: the folder structure of the core archive is slightly different from the standard manually installed Arduino IDE 1.5+
403+
compatible hardware folder structure. You must remove the architecture folder(e.g., `avr` or `arm`), moving all the
404+
files and folders within the architecture folder up a level.
405+
406+
407+
### Installation
373408

374409
The installation archives contain the Board support files.
375410

376411
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
412+
`.tar.zst` has been added, by the way, if you want to keep compatibility with older versions of Arduino IDE and Arduino
378413
CLI we recommend using one of the older formats.
379414

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

0 commit comments

Comments
 (0)