You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-18
Original file line number
Diff line number
Diff line change
@@ -29,16 +29,15 @@ Note that as part of the submission, a top-down view of the board in the form of
29
29
Once your draft has been made, before filing a pull request, you should try to render the page and make sure it build and appears as intended. To do so:
30
30
31
31
```bash
32
-
./draft/publish myboard
33
-
make serve LANG=en
32
+
draft/publish.sh myboard
33
+
make LANG=en serve
34
34
```
35
-
36
35
And then open: http://127.0.0.1:5000 in your browser.
37
36
38
37
Once you are happy with the result,
39
38
40
39
```bash
41
-
./draft/unpublish myboard
40
+
/draft/unpublish myboard
42
41
```
43
42
(this will file the overlay back into the draft folder, ready for review)
44
43
@@ -47,7 +46,7 @@ Once you are happy with the result,
47
46
48
47
*note 2: if you are facing issues with your preview (board not showing, text update not appearing, etc.), you can fix it by erasing your browser's cache (image and cache file only).*
49
48
50
-
If you feel that the requirements for submissions is beyond your current possibilities, you may raise an [issue]() requesting the addition of a specific board instead and we'll consider it!
49
+
If you feel that the requirements for submissions is beyond your current possibilities, you may raise an issue requesting the addition of a specific board instead and we'll consider it!
51
50
52
51
# Translating
53
52
@@ -67,28 +66,20 @@ make serve LANG=de
67
66
68
67
And then open: http://127.0.0.1:5000 in your browser.
69
68
70
-
The last step will be to submit your finished translation as a [pull request]() (this can include any number of boards, it does not have to be the entire line-up) and we'll get it live on its own *<languagecode>*.pinout.xyz subdomain.
69
+
The last step will be to submit your finished translation as a pull request (this can include any number of boards, it does not have to be the entire line-up) and we'll get it live on its own *<languagecode>*.pinout.xyz subdomain.
71
70
72
71
If you wish to provide a translation for an existing subdomain, or correct a typo in an existing markdown file, just edit the file in place (leaving the files in the `translate` folder for review, if you are pushing a translation).
73
72
74
-
If you have a question about translations, raise an [issue]() and we'll be happy to help you get past whatever hurdle you may face!
73
+
If you have a question about translations, raise an issue and we'll be happy to help you get past whatever hurdle you may face!
75
74
76
75
77
76
# Roadmap & wishlist
78
77
79
-
* Add as many [boards]() as possible!
78
+
* Add as many boards as possible!
80
79
81
80
# Acknowledgement
82
81
83
-
Maintainers: [@Gadgetoid](https://github.com/Gadgetoid) and [@RogueM](https://github.com/RogueM)
84
-
85
-
GPIO Zero code examples by: [@bennuttall](https://github.com/bennuttall)
Copy file name to clipboardExpand all lines: draft/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,4 +15,4 @@ I2C and SPI pins should be included if your board uses them, however they will g
15
15
16
16
Power pins and EEPROM should specifically be excluded, but specifying the power and eeprom fields are highly recommended if that info is known.
17
17
18
-
All of the above is further expended in the overlay template.md. We recommend you use this template as a starting point for any new add-on board submission and add or remove fields as required.
18
+
All of the above is further expended in the overlay template.md. We recommend you use this template as a starting point for any new add-on board submission and add or remove fields as required.
@@ -46,10 +30,8 @@ Use this section to provide additional information such as features, technical p
46
30
The overlay itself uses the following fields, some of which are mandatory, as noted below:
47
31
48
32
MANDATORY
49
-
* name: the board name as it will appear at pinout.xyz
33
+
* name: the board name as it will appear at 96boards/pinout
50
34
* class: the class the overlay falls in, 'board' is the most common (use that if in doubt).
51
-
* type: the typical applications of the board, i.e 'lcd' (use 'other' if in doubt). If multiple types apply, use a comma separated list (for example, 'adc,motor'). The keywords submitted will be used to filter boards on the site so don't include anything but tags that are relevant to the key functionality of the board.
52
-
* formfactor: the board's form factor. Valid values are Custom, HAT and pHAT. Note that an EEPROM is required for HAT specs, use Custom if that is not the case.
53
35
* manufacturer: the manufacturer's name.
54
36
* description: a description of what the add-on board provides.
55
37
* url: the main URL for the product providing detailed technical information about the board.
0 commit comments