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

and some more to stop my editor stripping trailing spaces

This commit is contained in:
RogueM 2016-11-02 15:22:27 +00:00
parent 1b339bfae9
commit 2cd0b55451
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,7 +4,7 @@
[Pinout.xyz](http://pinout.xyz/) is the successor to the popular Pi pinout website originally hosted on [http://pi.gadgetoid.com/pinout](http://pi.gadgetoid.com/pinout).
To support translation efforts, and allow people to build tools with the data in this repository, Pinout.xyz is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](href="http://creativecommons.org/licenses/by-nc-sa/4.0/).
To support translation efforts, and allow people to build tools with the data in this repository, Pinout.xyz is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).
This license excludes the 'pinout-graphic-horizontal' files located in the 'graphics' directory, which are provided under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/) to permit commercial use; specifically publication in books and magazines with appropriate attribution.
@ -22,9 +22,9 @@ If you've spotted an error, ommission or have a suggestion, raise an [issue](htt
#Contributing
If you have a board you'd like to contribute, the preferred method for submission is to create a modified version of the overlay [template](https://github.com/Gadgetoid/Pinout.xyz/blob/master/draft/overlay/template.md) and create a pull request.
If you have a board you'd like to contribute, the preferred method for submission is to create a modified version of the overlay [template](https://github.com/Gadgetoid/Pinout.xyz/blob/master/draft/overlay/template.md) and create a pull request. Please ensure the files you submit are being pushed to the `/draft` folder, where it will be reviewed before publication.
Please ensure the files you submit are being pushed to the `/draft` folder, where it will be reviewed before publication. Note that as part of the submission, a top-down view of the board in the form of a [png](https://github.com/Gadgetoid/Pinout.xyz/blob/master/draft/overlay/template.png) is expected, although optional. If you can't produce the png file yourself, just duplicate and rename `template.png` but make sure to include a url somewhere in the overlay where we can fetch a suitable graphic.
Note that as part of the submission, a top-down view of the board in the form of a [png](https://github.com/Gadgetoid/Pinout.xyz/blob/master/draft/overlay/template.png) is expected, although optional. If you can't produce the png file yourself, just duplicate and rename `template.png` but make sure to include a url somewhere in the overlay where we can fetch a suitable graphic.
If you feel that the requirements for submissions is beyond your current possibilities, you may raise an [issue](https://github.com/Gadgetoid/Pinout.xyz/issues) instead and we'll consider it!
@ -44,11 +44,12 @@ make serve LANG=de
And then open: http://127.0.0.1:5000 in your browser.
*note 1: you will need several python modules installed to render and serve a local version of the site, run `pip install -r requirements.txt` from the top of the repository tree to install the required modules.*
*note 1: you will need several python modules installed to render and serve a local version of the site, run*
*`pip install -r requirements.txt` from the top of the repository tree to install the required modules.*
*note 2: if you are facing issues on your preview (card not showing, text update not appearing ...), you can fix it by erasing you browser cache (image and cache file only)*
*note 2: if you are facing issues on your preview (card not showing, text update not appearing ...), you can fix it by erasing your browser's cache (image and cache file only)*
The last step will be to submit your finished translation as a [pull request](https://github.com/Gadgetoid/Pinout.xyz/pulls) and we'll get it live on its own *<languagecode>*.pinout.xyz subdomain :)
The last step will be to submit your finished translation as a [pull request](https://github.com/Gadgetoid/Pinout.xyz/pulls) and we'll get it live on its own *<languagecode>*.pinout.xyz subdomain :)
(this can include any number of boards, it does not have to be the entire line-up of boards)
#Roadmap & wishlist