From a35c8e075e0369293182511b6970b4f7bf8cd9ad Mon Sep 17 00:00:00 2001 From: Philip Howard Date: Tue, 24 Feb 2015 10:09:41 +0000 Subject: [PATCH] Create README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..662f821 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +#Pinout 2 + +Pinout 2 will be the successor to the popular Pi pinout website http://pi.gadgetoid.com/pinout + +This project aims to build a consistent workflow behind the Pinout front-end, and invite board manufacturers +to produce their own "overlay" files which describe which pins their Pi add-ons use. + +I hope that by making this project open and extensible I will invite not only contributions of board pinouts, +but translation efforts too. + +#Roadmap + +##Phase 1 + +Replace the current Pinout site with a generated version built from this repository, aim for 100% compatibility. + +* Drop ancient and redundant boards such as ladder, Clockatoo +* Replace things like Arduino with more relevant and up-to-date alternatives ( Alex's PiDuino ) +* Compliment Pibrella with Explorer HAT (Pro) + +##Phase 2 + +Redesign UI to support browsing a wider variety of boards and viewing their pinouts, description, links to library ++ buy links etc. + +* Replace top tabs with some sort of search functionality or easy categorised UI for finding boards +* Allow for slightly longer descriptions of Pin functions ( baloons? ), current width is very restrictive + +##Phase 3 + +Introduce advanced functionality such as board compatibility checks and more detailed overlays on Pin alt functions. + +* Does X board work with Y board +* What extra functions does this pin have +* Convert WiringPi to GPIO to BCM and back