Add example with library.json

This commit is contained in:
Ivan Kravets
2015-12-30 01:41:08 +02:00
parent 2dd2dd4f0d
commit e88ef48e18
2 changed files with 22 additions and 0 deletions

View File

@ -183,6 +183,16 @@ A version of the current library source code.
:ref:`libjson_repository` field. In this case
|PIOAPICR| will use the *CVS*-revision from the latest commit.
Example with fixed release/tag on GitHub:
.. code-block:: javascript
"version": "1.0.0",
"downloadUrl": "https://github.com/foo/bar/archive/v1.0.0.tar.gz",
"include": "bar-1.0.0"
See more ``library.json`` :ref:`library_creating_examples`.
.. _libjson_url:
@ -244,6 +254,7 @@ Pattern Meaning
* - ``[!seq]``
- matches any character not in seq
See more ``library.json`` :ref:`library_creating_examples`.
.. _libjson_exclude:
@ -329,6 +340,8 @@ Example:
]
See more ``library.json`` :ref:`library_creating_examples`.
.. _libjson_examples:
``examples``

View File

@ -146,3 +146,12 @@ The registration requirements:
Now, you can :ref:`register <cmd_lib_register>` your library and allow others
to :ref:`install <cmd_lib_install>` it.
.. _library_creating_examples:
Examples
--------
* `GitHub + fixed release <http://platformio.org/#!/lib/show/552/ACNoblex>`_
* `Dependencies by author and framework <http://platformio.org/#!/lib/show/3/PID-AutoTune>`_
* `Multiple libraries in the one repository <https://github.com/jrowberg/i2cdevlib/tree/master/Arduino>`_