diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index 151a1341..9a8db121 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -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`` diff --git a/docs/librarymanager/creating.rst b/docs/librarymanager/creating.rst index 3ab2a74c..1402488c 100644 --- a/docs/librarymanager/creating.rst +++ b/docs/librarymanager/creating.rst @@ -146,3 +146,12 @@ The registration requirements: Now, you can :ref:`register ` your library and allow others to :ref:`install ` it. + +.. _library_creating_examples: + +Examples +-------- + +* `GitHub + fixed release `_ +* `Dependencies by author and framework `_ +* `Multiple libraries in the one repository `_