Go to file
Philip Howard 8a1d2745bb Update generate-html.py 2015-04-07 18:39:47 +01:00
resources Fixed drop down bugs 2015-03-28 08:43:07 +00:00
src/en-GB Fixed the auto save from gedit 2015-04-06 19:51:08 +01:00
tools Moved defines to tools dir, added readme, generate-html now obeys lang arg 2015-03-26 14:14:59 +00:00
.gitignore Tidying up build process 2015-03-26 17:27:30 +00:00
Makefile Fixed dir creation bug in generate 2015-03-26 14:25:30 +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-html.py Update generate-html.py 2015-04-07 18:39:47 +01:00
pinout.py Tidying up build process 2015-03-26 17:27:30 +00:00
serve.py Tidying up build process 2015-03-26 17:27:30 +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