villivateur
/
pinout.vvzero.com
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Philip Howard 2016-09-27 21:34:35 +01:00 committed by GitHub
parent 46c19f0794
commit cc58a083b4
1 changed files with 19 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,23 +1,25 @@
#Pinout 2
#Pinout.xyz
Pinout 2 is the successor to the popular Pi pinout website http://pi.gadgetoid.com/pinout
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a>
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.
Pinout.xyz is the successor to the popular Pi pinout website originally hosted on 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.
To support translation efforts, and allow people to build tools with the data in this repository, Pinout.xyz is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
I hope that by making this project open and extensible I will invite not only contributions of board pinouts,
but translations too.
This license excludes the file pinout-graphic-horizontal.ai, which is provided under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a> to permit commercial use; specifically publication in books and magazines with appropriate attribution.
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.
#About this project
This project aims to build a consistent workflow behind the Pinout.xyz front-end, gather useful information about the Raspberry Pi GPIO interface and add-on boards, and invite board manufacturers to produce their own "overlay" files which describe which pins their Pi add-ons use.
We hope that by making this project open and extensible I will invite not only contributions of board pinouts, but translations too.
#Contributing
If you have a board you'd like to contribute, raise an issue and we'll consider it!
If you've spotted an error, ommission or have a suggestion then you're welcome to do the same.
#Translating
The contents of this GitHub repository are used to build http://pinout.xyz and its translated subdomains.
@ -31,10 +33,9 @@ Current known contributors are:
* 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`.
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! ).
There are no plans to support cultures (it would just get out of hand!), so you can't have `src/fr-CA` ( sorry! ).
Once you've made your translation, build and preview it with, for example:
@ -48,13 +49,11 @@ Please do not attempt to translate the `/resources` folder, this is shared betwe
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.
Submit your finished translation as a pull request and we'll get it live on its own pinout.xyz subdomain :)
#Roadmap
#Roadmap & wishlist
* 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 )
* Redesign HTML generation and unify HTML templates into a single, translatable file
* Add functionality to compare two or more boards, to visualise pin compatibility
* Tool to convert WiringPi to GPIO to BCM and back
* Add as many boards as possible!