Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
A
arduino-cli
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Operations
Operations
Metrics
Analytics
Analytics
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Commits
Open sidebar
xpstem
arduino-cli
Commits
b67b215b
Unverified
Commit
b67b215b
authored
May 31, 2023
by
Alessio Perugini
Committed by
GitHub
May 31, 2023
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve archive structure docs (#2189)
parent
41bd2e45
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
38 additions
and
2 deletions
+38
-2
docs/package_index_json-specification.md
docs/package_index_json-specification.md
+38
-2
No files found.
docs/package_index_json-specification.md
View file @
b67b215b
...
...
@@ -369,12 +369,48 @@ versions of the `PACKAGE`, 1.0.0 and 1.0.1. No `TOOLS` needed to be installed so
Here is the Boards Manager entry created by the example: !
[
Boards Manager screenshot
](
img/boards-manager-screenshot.png
)
## Installation archive structure
## Archive structure
It must contain a single folder in the root. All files and
`__MACOSX`
folder present in the root will be ignored.
Valid structure
```
.
└── avr/
├── bootloaders
├── cores
├── firmwares
├── libraries
├── variants
├── boards.txt
├── platform.txt
└── programmers.txt
```
Invalid structure:
```
.
├── avr/
│ ├── ...
│ ├── boards.txt
│ ├── platform.txt
│ └── programmers.txt
├── folder2
└── folder3
```
**Note**
: the folder structure of the core archive is slightly different from the standard manually installed Arduino
IDE 1.5+ compatible hardware folder structure. You must remove the architecture folder(e.g.,
`avr`
or
`arm`
), moving all
the files and folders within the architecture folder up a level.
### Installation
The installation archives contain the Board support files.
Supported formats are
`.zip`
,
`.tar.bz2`
, and
`.tar.gz`
. Starting from Arduino CLI >=0.30.0 support for
`.tar.xz`
, and
`.tar.zst`
has been added, by the way, if you want to keep compatiblity with older versions of Arduino IDE and Arduino
`.tar.zst`
has been added, by the way, if you want to keep compatib
i
lity with older versions of Arduino IDE and Arduino
CLI we recommend using one of the older formats.
The folder structure of the core archive is slightly different from the standard manually installed Arduino IDE 1.5+
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment