platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-30 10:07:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Hint to use library.json with repo+version

Browse Source
This commit is contained in:
Ivan Kravets
2015-12-31 00:47:03 +02:00
parent 4d3a6c9791
commit b588823799
1 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/librarymanager/config.rst
View File

@ -150,18 +150,6 @@ Example:
"url": "https://github.com/foo/bar.git" "url": "https://github.com/foo/bar.git"
} }
.. _libjson_downloadurl:
``downloadUrl``
---------------
*Required* if :ref:`libjson_repository` field is not defined | Type: ``String``
It is the *HTTP URL* to the archived source code of library. It should end
with the type of archive (``.zip`` or ``.tar.gz``).
.. _libjson_version: .. _libjson_version:
``version`` ``version``
@ -183,6 +171,27 @@ A version of the current library source code.
:ref:`libjson_repository` field. In this case :ref:`libjson_repository` field. In this case
|PIOAPICR| will use the *CVS*-revision from the latest commit. |PIOAPICR| will use the *CVS*-revision from the latest commit.
Example:
.. code-block:: javascript
"repository":
{
"type": "git",
"url": "https://github.com/foo/bar.git"
},
"version": "1.0.0"
.. _libjson_downloadurl:
``downloadUrl``
---------------
*Required* if :ref:`libjson_repository` field is not defined | Type: ``String``
It is the *HTTP URL* to the archived source code of library. It should end
with the type of archive (``.zip`` or ``.tar.gz``).
Example with fixed release/tag on GitHub: Example with fixed release/tag on GitHub:
.. code-block:: javascript .. code-block:: javascript
@ -191,7 +200,6 @@ Example with fixed release/tag on GitHub:
"downloadUrl": "https://github.com/foo/bar/archive/v1.0.0.tar.gz", "downloadUrl": "https://github.com/foo/bar/archive/v1.0.0.tar.gz",
"include": "bar-1.0.0" "include": "bar-1.0.0"
See more ``library.json`` :ref:`library_creating_examples`. See more ``library.json`` :ref:`library_creating_examples`.
.. _libjson_url: .. _libjson_url: