mirror of https://github.com/arduino/arduino-ide.git synced 2025-11-09 18:38:33 +00:00

Files

Per Tillisch ee4f74d566 Document localization capabilities in Translator Guide

The system used for localization of this project leverages the infrastructure and data that already exists for VS Code.
These assets are applicable to Arduino IDE 2.x due to the project being built on the Eclipse Theia IDE framework. In
this way, the Arduino IDE developers and community are only responsible for internationalization and localization of the
Arduino-specific strings (e.g., "Sketchbook") used in the IDE's UI.

The unfortunate downside to this approach is that there is a hard technical limit on localization of the project to
languages for which a VS Code "language pack" is available.

It will be helpful to clearly communicate the set of languages for which we are able to ship contributions from
translators.

Likewise, it will be useful to also communicate that, we are able to ship contributions of translations of Arduino CLI
user interface strings for any language. This is due to the fact that the Arduino CLI codebase uses a completely
different internationalization system that does not impose any technical limits on the scope of localization.

2025-07-15 19:32:12 -07:00

assets

Move documentation assets to standard location

2022-09-15 05:53:09 -07:00

contributor-guide

Document localization capabilities in Translator Guide

2025-07-15 19:32:12 -07:00

internal

chore: use Node.js >=18.17.0

2023-09-26 10:06:47 +02:00

advanced-usage.md

Document 3rd party theme installation in "Advanced Usage"

2023-04-20 11:11:24 -07:00

CONTRIBUTING.md

Add a dedicated translator guide document

2022-09-26 05:07:34 -07:00

development.md

fix(doc): add missing prerequisites to dev docs (#2531 )

2024-10-26 17:15:23 -07:00

README.md

chore: format resources 💄

2023-09-26 10:06:47 +02:00

README.md

Cloud Sketchbook

Arduino IDE provides a Cloud Sketchbook feature that can be used to upload sketches to Arduino Cloud.

In order to use this feature, a user must be registered on Arduino Cloud and logged in. This feature is completely optional and can be disabled in the IDE via the "File > Advanced > Hide Cloud Sketchbook" menu item.

Developer guide

A developer could use the content of this repo to create a customized version of this feature and implement a different remote storage as follows:

1. Changing remote connection parameters in the Preferences panel (be careful while editing the Preferences panel!)

Here a screenshot of the Preferences panel

The settings under Arduino > Auth should be edited to match the OAuth2 configuration of your custom cloud sketchbook storage
The setting under Arduino > Sketch Sync Endpoint should be edited to point to your custom cloud sketchbook storage service

2. Implementing the Arduino Cloud Store APIs for your custom cloud sketchbook storage

Following the API Reference below:

API Call	OpenAPI documentation
DELETE create/v2/files/d/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_deletedir
DELETE create/v2/files/f/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_deletefile
GET create/v2/files/d/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_list
GET create/v2/files/f/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_read
GET create/v2/sketches	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_search
GET create/v2/sketches/byID/{id}	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_byID
GET create/v2/sketches/byPath{path}	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_byPath
POST create/v2/files/d/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_mkdir
POST create/v2/files/f/$HOME/sketches_v2{posixPath}	https://api2.arduino.cc/create/docs#!/files95v2/files_v2_write
POST create/v2/sketches/{sketch.id}	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_edit
POST create/v3/files/cp	https://api2.arduino.cc/create/docs#!/files95v3/files_v3_copy
POST create/v3/files/mv	https://api2.arduino.cc/create/docs#!/files95v3/files_v3_move
PUT create/v2/sketches	https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_create

Build the Arduino IDE with this extension

To build the Arduino IDE with this extension, run the following in a terminal. On Windows, use Git Bash.

./bootstrap.sh