feedc0de/platformio-core
1
0
Fork 0
forked from platformio/platformio-core
Code Pull Requests Activity

Corrections

Browse Source
This commit is contained in:
Ivan Kravets
2014-09-09 23:16:36 +03:00
parent 813c818477
commit fbe014f687
2 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/librarymanager/config.rst
View File

@ -7,12 +7,12 @@ library.json
``library.json`` in a `JSON-style <http://en.wikipedia.org/wiki/JSON>`_. ``library.json`` in a `JSON-style <http://en.wikipedia.org/wiki/JSON>`_.
A data in ``library.json`` should be represented via A data in ``library.json`` should be represented via
`associative array <http://en.wikipedia.org/wiki/Associative_array>`_ `associative array <http://en.wikipedia.org/wiki/Associative_array>`_
(name/value pairs). An order doesn't make a sense. (name/value pairs). An order doesn't matter.
The allowable fields (names from pairs) are described below. The fields The allowable fields (names from pairs) are described below. The fields
(:ref:`libjson_name`, :ref:`libjson_description` and :ref:`libjson_keywords`) (:ref:`libjson_name`, :ref:`libjson_description` and :ref:`libjson_keywords`)
will be displayed in search results on the :ref:`cmd_lib_search` will be displayed in the search results at the :ref:`cmd_lib_search` (*CLI*)
(*CLI*) and the *WebSite* that can be used to search for libraries. and at the *WebSite*. Also, they can be used for searching for libraries.
.. contents:: .. contents::
@ -40,9 +40,9 @@ A name of the library.
**Required** | Type: ``String`` | Max. Length: 255 **Required** | Type: ``String`` | Max. Length: 255
Help users identify and search for your library with a brief description. The field helps users to identify and search for your library with a brief
Describe the hardware devices (sensors, boards and etc.) which are suitable description. Describe the hardware devices (sensors, boards and etc.) which
with it. are suitable with it.
.. _libjson_keywords: .. _libjson_keywords:
@ -52,12 +52,12 @@ with it.
**Required** | Type: ``String`` | Max. Length: 255 **Required** | Type: ``String`` | Max. Length: 255
Used for search by keyword. Helps make your library easier to discover without Used for search by keyword. Helps to make your library easier to discover
people needing to know its name. without people needing to know its name.
The keyword should be lowercased, can contain a-z, digits and dash (but not The keyword should be lowercased, can contain a-z, digits and dash (but not
start/end with them). A list from the keywords can be specified with start/end with them). A list from the keywords can be specified with
separator ``,``. separator ``,``
.. _libjson_version: .. _libjson_version:
@ -108,7 +108,7 @@ Example:
.. note:: .. note::
You can omit :ref:`libjson_author` field and define You can omit :ref:`libjson_author` field and define
:ref:`libjson_repository` field. The only *GitHub-based* repository is :ref:`libjson_repository` field. Only *GitHub-based* repository is
supported now. In this case supported now. In this case
*PlatformIO-API Crawler* will use information from *PlatformIO-API Crawler* will use information from
`GitHub API Users <https://developer.github.com/v3/users/>`_. `GitHub API Users <https://developer.github.com/v3/users/>`_.
@ -141,8 +141,8 @@ Example:
*Required* if :ref:`libjson_repository` field is not defined | Type: ``String`` *Required* if :ref:`libjson_repository` field is not defined | Type: ``String``
The *HTTP URL* to archived source code of library. It should end with the type It is the *HTTP URL* to the archived source code of library. It should end
of archive (``.zip`` or ``.tar.gz``). with the type of archive (``.zip`` or ``.tar.gz``).
.. _libjson_include: .. _libjson_include:

4
docs/librarymanager/creating.rst
View File

@ -17,8 +17,8 @@ Source Code Location
There are a several ways how to share your library with the whole world There are a several ways how to share your library with the whole world
(see `examples <https://github.com/ivankravets/platformio-libmirror/tree/master/configs>`_). (see `examples <https://github.com/ivankravets/platformio-libmirror/tree/master/configs>`_).
You can hold a lot of libraries (split into separated folders) inside the one You can hold a lot of libraries (split into separated folders) inside one of
repository/archive. In this case please use :ref:`libjson_include` the repository/archive. In this case please use :ref:`libjson_include`
field to specify the relative path to your library's source code. field to specify the relative path to your library's source code.