jepler/circuitpython-org
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update board instructions

Browse source
This commit is contained in:
Scott Shawcroft 2019-03-08 19:07:43 -08:00
parent 36b4bf2e65
commit 43703101e2
No known key found for this signature in database
GPG key ID: FD0EDC4B6C53CA59
2 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -19,6 +19,6 @@ TODO
# To add a new board to the site:
1. Edit _data/metadata.json and add a new object in the array with the board details.
2. Commit and push the code. A file will be automatically generated in _downloads/board_id.description_type
3. Edit the description and save the file
1. Duplicate `_board/template.md` to `_board/<board id>.md`.
2. Edit `_board/<board id>.md` according to the template's instructions.
3. Create a pull request with the file changes.

17
_board/template.md Normal file
View file

@ -0,0 +1,17 @@
---
layout: download
board_id: "<board id>"
title: "<board name> Download"
name: "<board name>"
manufacturer: "<board manufacturer>"
board_url: ""
board_image: "/assets/images/boards/unknown.jpg"
---
This board hasn't been fully documented yet. Please make a pull request adding more info to this file.
The description should be written to inform a CircuitPython user what makes the board unique and link to relevant info about it.
## Purchase
Add any links to purchase the board
* [Adafruit](https://www.adafruit.com/product/3857)