From 02c76a7d1e9f34cecbbc5c22aa28a535f47ddcd4 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Sat, 21 Mar 2015 19:05:36 +0000 Subject: [PATCH] Updated docs --- overlay/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/overlay/README.md b/overlay/README.md index b48b713..ab5f112 100644 --- a/overlay/README.md +++ b/overlay/README.md @@ -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.