diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst index 1268121a..cb44bd46 100644 --- a/docs/librarymanager/index.rst +++ b/docs/librarymanager/index.rst @@ -14,21 +14,44 @@ Library Manager =============== -*PlatformIO Library Manager* allows you to organize external embedded libraries. -You can search for new libraries via +*PlatformIO Library Manager* is a tool for managing libraries of +`PlatformIO Registry `__ and VCS repositories (Git, +Hg, SVN). It makes it exceedingly simple to find, install and keep libraries +up-to-date. PlatformIO Library Manager supports +`Semantic Versioning `_ and its rules. -* :ref:`Command Line interface ` -* `Web 2.0 Library Search `_ +There 2 options how to find library: -You don't need to bother for finding the latest version of library. Due to -:ref:`cmd_lib_update` command you will have up-to-date external libraries. +* :ref:`Command Line Interface ` +* `Web-based Library Search `__ + +*PlatformIO Library Manager* allows to manage different library storages using +:option:`platformio lib --global` or :option:`platformio lib --storage-dir` +options. + +Project dependencies +-------------------- + +*PlatformIO Library Manager* allows to specify project dependencies +(:ref:`projectconf_lib_deps`) that will be installed automatically per project +before environment processing. You do not need to install libraries manually. +The only one simple step is to define dependencies in :ref:`projectconf`. +You can use library ID, Name or even repository URL. For example, + +.. code-block:: ini + + [env:myenv] + platform = ... + framework = ... + board = ... + lib_deps = + 13 + PubSubClient + Json@~5.6,!=5.4 + https://github.com/gioblu/PJON.git@v2.0 + https://github.com/me-no-dev/ESPAsyncTCP.git + +Please follow to :ref:`cmd_lib_install` for detailed documentation about +possible values. .. image:: ../_static/platformio-demo-lib.gif - -.. toctree:: - :maxdepth: 2 - - User Guide <../userguide/lib/index.rst> - ldf - config - creating diff --git a/docs/projectconf.rst b/docs/projectconf.rst index 42eb6b8a..65ebc182 100644 --- a/docs/projectconf.rst +++ b/docs/projectconf.rst @@ -651,7 +651,7 @@ Library options Please make sure to read :ref:`ldf` guide first. Specify project dependencies that should be installed automatically to -:ref:`projectconf_pio_libdeps_dir` before an environment process. +:ref:`projectconf_pio_libdeps_dir` before environment processing. Multiple dependencies are allowed (multi-lines). **Valid forms** @@ -674,7 +674,7 @@ Example: [env:depends_on_some_libs] lib_deps = - 1 + 13 PubSubClient Json@~5.6,!=5.4 https://github.com/gioblu/PJON.git@v2.0