diff --git a/HISTORY.rst b/HISTORY.rst index a948fcfa..74948581 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -20,6 +20,8 @@ PlatformIO 3.0 * Handle extra build flags and build script from `library.json `__ (`issue #289 `_) +* Added ``license`` field to `library.json `__ + (`issue #522 `_) * Show detailed build information about dependent libraries (`issue #617 `_) * Embedded Board compatibility with more than one development platform diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index 50a82cc9..709e42ff 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -222,6 +222,19 @@ Example: }, "version": "1.0.0" + +``license`` +----------- + +A license of the library. You can check +`the full list of SPDX license IDs `_. Ideally you +should pick one that is `OSI `_ +approved. + +.. code-block:: javascript + + "license": "Apache-2.0" + .. _libjson_downloadurl: ``downloadUrl`` @@ -479,7 +492,7 @@ options: "flags": "-std=c99" } -4. Build source files (``c, cpp, h``) only from the root of the library +4. Build source files (``c, cpp, h``) at the top level of the library .. code-block:: javascript