Skip to content

Commit 54c4ad0

Browse files
committed
Deployed 3dca438 to dev with MkDocs 1.6.1 and mike 1.1.2
1 parent 87963f9 commit 54c4ad0

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/sketch-project-file/index.html

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1459,7 +1459,11 @@ <h2 id="build-profiles">Build profiles<a class="headerlink" href="#build-profile
14591459
<li>The target core platform name and version (with the 3rd party platform index URL if needed)</li>
14601460
<li>A possible core platform name and version, that is a dependency of the target core platform (with the 3rd party
14611461
platform index URL if needed)</li>
1462-
<li>The libraries used in the sketch (including their version)</li>
1462+
<li>A list of libraries used in the sketch. Each library could be:<ul>
1463+
<li>a library taken from the Arduino Libraries Index</li>
1464+
<li>a library installed anywhere in the filesystem</li>
1465+
</ul>
1466+
</li>
14631467
<li>The port and protocol to upload the sketch and monitor the board</li>
14641468
</ul>
14651469
<p>The format of the file is the following:</p>
@@ -1474,9 +1478,8 @@ <h2 id="build-profiles">Build profiles<a class="headerlink" href="#build-profile
14741478
- platform: &lt;PLATFORM_DEPENDENCY&gt; (&lt;PLATFORM_DEPENDENCY_VERSION&gt;)
14751479
platform_index_url: &lt;3RD_PARTY_PLATFORM_DEPENDENCY_URL&gt;
14761480
libraries:
1477-
- &lt;LIB_NAME&gt; (&lt;LIB_VERSION&gt;)
1478-
- &lt;LIB_NAME&gt; (&lt;LIB_VERSION&gt;)
1479-
- &lt;LIB_NAME&gt; (&lt;LIB_VERSION&gt;)
1481+
- &lt;INDEX_LIB_NAME&gt; (&lt;INDEX_LIB_VERSION&gt;)
1482+
- dir: &lt;LOCAL_LIB_PATH&gt;
14801483
port: &lt;PORT_NAME&gt;
14811484
port_config:
14821485
&lt;PORT_SETTING_NAME&gt;: &lt;PORT_SETTING_VALUE&gt;
@@ -1496,8 +1499,14 @@ <h2 id="build-profiles">Build profiles<a class="headerlink" href="#build-profile
14961499
<li><code>&lt;PLATFORM_DEPENDENCY&gt;</code>, <code>&lt;PLATFORM_DEPENDENCY_VERSION&gt;</code>, and <code>&lt;3RD_PARTY_PLATFORM_DEPENDENCY_URL&gt;</code> contains the same
14971500
information as <code>&lt;PLATFORM&gt;</code>, <code>&lt;PLATFORM_VERSION&gt;</code>, and <code>&lt;3RD_PARTY_PLATFORM_URL&gt;</code> respectively but for the core
14981501
platform dependency of the main core platform. These fields are optional.</li>
1499-
<li><code>libraries:</code> is a section where the required libraries to build the project are defined. This section is optional.</li>
1500-
<li><code>&lt;LIB_VERSION&gt;</code> is the version required for the library, for example, <code>1.0.0</code>.</li>
1502+
<li><code>libraries:</code> is a section where the required libraries to build the project are defined. This section is optional.<ul>
1503+
<li><code>&lt;INDEX_LIB_NAME&gt; (&lt;INDEX_LIB_VERSION&gt;)</code> represents a library from the Arduino Libraries Index, for example,
1504+
<code>MyLib (1.0.0)</code>.</li>
1505+
<li><code>dir: &lt;LOCAL_LIB_PATH&gt;</code> represents a library installed in the filesystem and <code>&lt;LOCAL_LIB_PATH&gt;</code> is the path to the
1506+
library. The path could be absolute or relative to the sketch folder. This option is available since Arduino CLI
1507+
1.3.0.</li>
1508+
</ul>
1509+
</li>
15011510
<li><code>&lt;USER_NOTES&gt;</code> is a free text string available to the developer to add comments. This field is optional.</li>
15021511
<li><code>&lt;PROGRAMMER&gt;</code> is the programmer that will be used. This field is optional.</li>
15031512
</ul>

0 commit comments

Comments
 (0)