villivateur
/
pinout.vvzero.com
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
513 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
RogueM a16629a00d Generate langlist from srcdir 2016-07-27 20:23:05 +01:00
draft Generate langlist from srcdir 2016-07-27 20:23:05 +01:00
resources Dots png rename 2016-07-27 15:13:51 +01:00
src Generate langlist from srcdir 2016-07-27 20:23:05 +01:00
tools Minor code reformatting 2015-11-18 13:52:15 +00:00
.gitignore Tidying up build process 2015-03-26 17:27:30 +00:00
Makefile Merged lang rename 2015-11-13 23:16:37 +00:00
README.md 'type_phat' string added 2015-12-03 17:31:15 +00:00
TODO.md Updated TODO 2015-03-25 00:30:28 +00:00
changelog.md Generate langlist from srcdir 2016-07-27 20:23:05 +01:00
convert.py Minor code reformatting 2015-11-18 13:52:15 +00:00
data.json misc 2015-06-25 17:02:47 +01:00
generate-html.py Fix for USB-based boards with no particular pinout 2016-06-26 22:05:41 +01:00
generate-json.py 'type_phat' string added 2015-12-03 17:31:15 +00:00
make_all.sh Script to build all languages 2015-11-18 13:16:39 +00:00
markjaml.py Minor code reformatting 2015-11-18 13:52:15 +00:00
pinout.py Implemented overlay categorisation and alphabetized menus 2016-02-16 21:41:40 +00:00
serve.py Minor code reformatting 2015-11-18 13:52:15 +00:00
urlmapper.py Minor code reformatting 2015-11-18 13:52:15 +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 - @rdmueller and @KojoePi
  • es - @ResonantWave
  • fr - @RogueM
  • it - @LizardM4
  • pt - @Maslor
  • tr - @Ardakilic

If you would like to provide support for a language not yet in the repository you should start by duplicating the src/en directory to the appropriate culture. For example if you want to create a German translation you would create the folder src/de.

There are no plans to support cultures, so you can't have src/fr-CA ( sorry! ).

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

make serve LANG=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