Go to file
Phil Howard ae1a3a41b6 Updated readme, added license, enhanced SPI overlay 2015-03-25 23:13:28 +00:00
description Added more pin content 2015-03-25 00:29:41 +00:00
overlay Updated readme, added license, enhanced SPI overlay 2015-03-25 23:13:28 +00:00
resources Added support for alt functions, improved CSS/layout 2015-03-24 23:51:14 +00:00
template Added more pin content 2015-03-25 00:29:41 +00:00
.gitignore Updates, working overlay pages 2015-03-21 17:27:02 +00:00
Makefile Updates, working overlay pages 2015-03-21 17:27:02 +00:00
README.md Updated readme, added license, enhanced SPI overlay 2015-03-25 23:13:28 +00:00
TODO.md Updated TODO 2015-03-25 00:30:28 +00:00
convert.py Initial Commit 2015-02-24 09:59:29 +00:00
generate-defines.py New script for generating defined pinouts for scripts 2015-03-25 19:30:34 +00:00
generate-html.py Added support for alt functions, improved CSS/layout 2015-03-24 23:51:14 +00:00
pi-pinout.json Fixed ancient typo, thanks Alex 2015-03-25 20:22:22 +00:00

README.md

#Pinout 2

Pinout 2 is the successor to the popular Pi pinout website http://pi.gadgetoid.com/pinout

To support translation efforts, and allow people to build tools with the data in this repository, Pinout 2 is provided under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

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 translations too.

I'm also looking for feedback about the structure of the JSON files, what information needs to be contained in them, how they can better support translation and any other suggestions you might have.

#Contributing

The contents of this GitHub repository are used to build http://pi.gadgetoid.com/pinout.

If you have a board you'd like to contribute, you should look at these folders:

#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