villivateur
/
pinout.vvzero.com
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
147 Commits 1 Branch 0 Tags 55 MiB
Python 48%
CSS 19.6%
JavaScript 11.2%
SCSS 10.5%
HTML 6.7%
Other 4%
Go to file
Andrew Scheller dac59c2bd8 Remove unused python imports from pinout.py 2015-11-12 02:10:37 +00:00
resources Added flag region icons 2015-11-10 20:41:15 +00:00
src Set mystery undocumented ground URL fudge 2015-11-11 21:33:06 +00:00
tools Update micropin.jquery.js 2015-05-07 12:43:12 +01:00
.gitignore Tidying up build process 2015-03-26 17:27:30 +00:00
Makefile Added credits, tweaked dac+ 2015-11-07 20:34:10 +00:00
README.md WIP FR overlays marked as such, to avoid confusion + de-DE credits 2015-11-11 11:35:33 +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
data.json misc 2015-06-25 17:02:47 +01:00
generate-html.py Better language interlinking 2015-11-08 21:21:57 +00:00
generate-json.py misc 2015-06-25 17:02:47 +01:00
markjaml.py Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
pinout.py Remove unused python imports from pinout.py 2015-11-12 02:10:37 +00:00
serve.py Remove unused python imports from serve.py 2015-11-12 02:10:00 +00:00
urlmapper.py Remove unused python imports from urlmapper.py 2015-11-12 02:07:46 +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

If you have a board you'd like to contribute, raise an issue and we'll consider it!

#Translating

The contents of this GitHub repository are used to build http://pinout.xyz and its translated subdomains.

Current known contributors are:

  • de-DE - @rdmueller and KojoePi
  • es-ES - @ResonantWave
  • fr-FR - @RogueM
  • tr-TR - @Ardakilic

We're looking for ( based on traffic ):

  • Italian, it-IT
  • Polish pl-PL
  • And any others!

You should start by duplicating the src/en-GB directory to the appropriate culture. For example if you want to create a German translation you would create the folder src/de-DE.

At the moment cultures are not fully supported, so you can't have src/fr-CA ( sorry! ), and there are no plans for this.

Once you've made your translation, build and preview it with, for example:

make serve LANG=de-DE

And then open: http://127.0.0.1:5000 in your browser.

Please do not attempt to translate the /resources folder, this is shared between sites on the server and should be generic.

Feel free to modify the template with links relevent to your country, and your Twitter handle but don't fiddle with the structure!

Submit your finished translation as a pull request and I'll get it live on pinout.xyz.

#Roadmap

  • Redesign UI to support browsing a wider variety of boards and viewing their pinouts ( partially done with drop down )
  • 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
  • Does X board work with Y board
  • What extra functions does this pin have ( mostly done with ALT functions tables, but needs descriptions )
  • Tool to convert WiringPi to GPIO to BCM and back