villivateur
/
pinout.vvzero.com
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated docs

This commit is contained in:
Phil Howard 2015-03-21 19:05:36 +00:00
parent 5f6433e47b
commit 02c76a7d1e
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
overlay/README.md
View File

@ -6,8 +6,10 @@ An overlay is constructed from a JSON file and, optionally, a markdown file cont
##JSON Format
The JSON overlay file must include a name, manufacturer name, URL, description
( short description required, long is optional ) and a "pin" array.
The JSON overlay file must include a name, manufacturer name, URL, description and a "pin" array defining all the
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
of that pin.