From 5b1ceccd1fbec127a638d4a29bf20eaf22731c99 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Thu, 3 Dec 2015 00:40:17 +0200 Subject: [PATCH] Add Quickstart for Library Manager --- docs/demo.rst | 2 +- docs/index.rst | 1 + docs/librarymanager/index.rst | 26 ++++++++++++++++++++++++++ docs/userguide/lib/index.rst | 11 +---------- 4 files changed, 29 insertions(+), 11 deletions(-) create mode 100644 docs/librarymanager/index.rst diff --git a/docs/demo.rst b/docs/demo.rst index 1511b9c9..6e84f7f9 100644 --- a/docs/demo.rst +++ b/docs/demo.rst @@ -50,7 +50,7 @@ Library Manager Used in demo ~~~~~~~~~~~~ -1. :ref:`librarymanager` +1. :ref:`userguide_lib` 2. :ref:`platformio lib search 1-wire ` command 3. :ref:`platformio lib install 54 ` command 4. :ref:`platformio lib search -f mbed ` command diff --git a/docs/index.rst b/docs/index.rst index 5ba1b031..b912dd51 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -103,6 +103,7 @@ Contents :caption: Library Manager :maxdepth: 2 + Quickstart User Guide librarymanager/config librarymanager/creating diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst new file mode 100644 index 00000000..43974d67 --- /dev/null +++ b/docs/librarymanager/index.rst @@ -0,0 +1,26 @@ +.. Copyright 2014-2015 Ivan Kravets + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +.. _librarymanager: + +Library Manager +=============== + +*PlatformIO Library Manager* allows you to organize external embedded libraries. +You can search for new libraries via + +* :ref:`Command Line interface ` +* `Web 2.0 Library Search `_ + +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. + +.. image:: ../_static/platformio-demo-lib.gif diff --git a/docs/userguide/lib/index.rst b/docs/userguide/lib/index.rst index e077e2eb..2267c1ad 100644 --- a/docs/userguide/lib/index.rst +++ b/docs/userguide/lib/index.rst @@ -9,20 +9,11 @@ See the License for the specific language governing permissions and limitations under the License. -.. _librarymanager: +.. _userguide_lib: Library Manager =============== -*PlatformIO Library Manager* allows you to organize external embedded libraries. -You can search for new libraries via - -* :ref:`Command Line interface ` -* `Web 2.0 Library Search `_ - -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. - To print all available commands and options use: .. code-block:: bash