forked from karpour/Library-Template-Arduino
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlibrary.properties
34 lines (32 loc) · 3.24 KB
/
library.properties
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
#
# name - the name of the library. Library names must contain only basic letters (A-Z or a-z) and numbers (0-9), spaces ( ), underscores (_), dots (.) and dashes (-). It cannot start or end with a space, and also it cannot start with a number. Note that libraries with a name value starting with Arduino will no longer be allowed addition to the Library Manager index as these names are now reserved for official Arduino libraries.
# version - version of the library. Version should be semver compliant. 1.2.0 is correct; 1.2 is accepted; r5, 003, 1.1c are invalid
# author - name/nickname of the authors and their email addresses (not mandatory) separated by comma ","
# maintainer - name and email of the maintainer
# sentence - a sentence explaining the purpose of the library
# paragraph - a longer description of the library. The value of sentence always will be prepended, so you should start by writing the second sentence here
# category - (defaults to Uncategorized) if present, one of these:
# Display
# Communication
# Signal Input/Output
# Sensors
# Device Control
# Timing
# Data Storage
# Data Processing
# Other
# url - the URL of the library project, for a person to visit. For example, the library's GitHub page. This is used for the "More info" links in Library Manager
# architectures - (defaults to *) a comma separated list of architectures supported by the library. If the library doesn’t contain architecture specific code use * to match all architectures. This field is used as one factor in determining priority when multiple libraries match an #include directive and to provide a warning message when the library is compiled for a board of an architecture that doesn't match any on the list.
# dot_a_linkage - (available from IDE 1.6.0 / arduino-builder 1.0.0-beta13) (optional) when set to true, the library will be compiled using a .a (archive) file. First, all source files are compiled into .o files as normal. Then instead of including all .o files in the linker command directly, all .o files are saved into a .a file, which is then included in the linker command. 1.5 format library folder structure is required.
# includes - (available from IDE 1.6.10) (optional) a comma separated list of files to be added to the sketch as #include <...> lines. This property is used with the "Include library" command in the IDE. If the includes property is missing all the headers files (.h) on the root source folder are included.
# precompiled - (available from Arduino IDE 1.8.6/arduino-builder 1.4.0) (optional) set to true to allow the use of .a (archive) and .so (shared object) files. The .a/.so file must be located at src/{build.mcu} where {build.mcu} is the architecture name of the target the file was compiled for. Ex: cortex-m3 for the Arduino DUE. The static library should be linked as an ldflag.
# ldflags - (available from Arduino IDE 1.8.6/arduino-builder 1.4.0) (optional) the linker flags to be added. Ex: ldflags=-lm
name=FancyESPSerial
version=1.0.0
author=Marley Plant <[email protected]>
maintainer=Marley Plant <[email protected]>
sentence=A Library To Enable Basic UI and Commands Over Serial
paragraph=Progress Bars, Menus and More
category=Communication
url=https://github.com/MarleyPlant/FancyESPSerial
architectures=*