Update docs for Library Manager

This commit is contained in:
Ivan Kravets
2016-08-24 00:26:28 +03:00
parent f1a14a03af
commit e6fc0e30ec
2 changed files with 39 additions and 16 deletions

View File

@ -14,21 +14,44 @@
Library Manager Library Manager
=============== ===============
*PlatformIO Library Manager* allows you to organize external embedded libraries. *PlatformIO Library Manager* is a tool for managing libraries of
You can search for new libraries via `PlatformIO Registry <http://platformio.org/lib>`__ 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 <http://semver.org>`_ and its rules.
* :ref:`Command Line interface <cmd_lib_search>` There 2 options how to find library:
* `Web 2.0 Library Search <http://platformio.org/lib>`_
You don't need to bother for finding the latest version of library. Due to * :ref:`Command Line Interface <cmd_lib_search>`
:ref:`cmd_lib_update` command you will have up-to-date external libraries. * `Web-based Library Search <http://platformio.org/lib>`__
*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 .. image:: ../_static/platformio-demo-lib.gif
.. toctree::
:maxdepth: 2
User Guide <../userguide/lib/index.rst>
ldf
config
creating

View File

@ -651,7 +651,7 @@ Library options
Please make sure to read :ref:`ldf` guide first. Please make sure to read :ref:`ldf` guide first.
Specify project dependencies that should be installed automatically to 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). Multiple dependencies are allowed (multi-lines).
**Valid forms** **Valid forms**
@ -674,7 +674,7 @@ Example:
[env:depends_on_some_libs] [env:depends_on_some_libs]
lib_deps = lib_deps =
1 13
PubSubClient PubSubClient
Json@~5.6,!=5.4 Json@~5.6,!=5.4
https://github.com/gioblu/PJON.git@v2.0 https://github.com/gioblu/PJON.git@v2.0