Updated docs
This commit is contained in:
parent
5f6433e47b
commit
02c76a7d1e
|
@ -6,8 +6,10 @@ An overlay is constructed from a JSON file and, optionally, a markdown file cont
|
||||||
|
|
||||||
##JSON Format
|
##JSON Format
|
||||||
|
|
||||||
The JSON overlay file must include a name, manufacturer name, URL, description
|
The JSON overlay file must include a name, manufacturer name, URL, description and a "pin" array defining all the
|
||||||
( short description required, long is optional ) and a "pin" array.
|
pins that the board uses.
|
||||||
|
|
||||||
|
If a counterpart .md file is present in description/overlay it will be used for the long description.
|
||||||
|
|
||||||
The pin array must list each pin by its *physical* location, and include at least a "name" describing the function
|
The pin array must list each pin by its *physical* location, and include at least a "name" describing the function
|
||||||
of that pin.
|
of that pin.
|
||||||
|
|
Loading…
Reference in New Issue