Skip to content

Commit ffa84fd

Browse files
author
Roberto Sora
authored
[skip changelog] [skip ci] Clarify additional-urls option usage (#548)
* [skip changelog] [skip ci] Clarify additional-urls option usage * rephrase flag warning * stress 3rd party point
1 parent e335327 commit ffa84fd

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.rst

+17-14
Original file line numberDiff line numberDiff line change
@@ -293,21 +293,10 @@ Great! Now we are ready to compile and upload the sketch.
293293
Adding 3rd party cores
294294
^^^^^^^^^^^^^^^^^^^^^^
295295

296-
If your board requires 3rd party core packages to work, you can pass a link to
297-
the the additional package index file with the ``--additional-urls`` option to
298-
any command that require a platform core to work:
296+
If your board requires 3rd party core packages to work, you can list the URLs
297+
to additional package indexes in the Arduino CLI configuration file.
299298

300-
.. code:: console
301-
302-
$ arduino-cli core search esp8266 --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json
303-
ID Version Name
304-
esp8266:esp8266 2.5.2 esp8266
305-
306-
To avoid passing the ``--additional-urls`` option every time you run a command,
307-
you can list the URLs to additional package indexes in the Arduino CLI
308-
configuration file.
309-
310-
For example, to add the ESP8266 core, edit the configration file and change the
299+
For example, to add the ESP8266 core, edit the configuration file and change the
311300
``board_manager`` settings as follows:
312301

313302
.. code:: yaml
@@ -330,6 +319,20 @@ additional URL from the configuration file:
330319
ID Version Name
331320
esp8266:esp8266 2.5.2 esp8266
332321
322+
Alternatively, you can pass a link to the the additional package index file with
323+
the ``--additional-urls`` option, that has to be specified every time and for every
324+
command that operates on a 3rd party platform core, for example:
325+
326+
.. code:: console
327+
328+
$ arduino-cli core update-index --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json
329+
Updating index: package_esp8266com_index.json downloaded
330+
331+
$ arduino-cli core search esp8266 --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json
332+
ID Version Name
333+
esp8266:esp8266 2.5.2 esp8266
334+
335+
333336
Compile and upload the sketch
334337
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
335338

0 commit comments

Comments
 (0)