Adafruit How to add a New Board User Manual
How to add a New Board to the circuitpython.org website
Created by Melissa LeBlanc-Williams
Last updated on 2021-01-21 03:04:15 PM EST
2
4
4
5
5
7
7
8
8
9
11
11
11
12
12
12
12
13
13
13
13
13
13
13
13
13
13
14
15
15
15
16
16
17
17
17
17
17
17
17
17
17
17
17
18
18
18
18
18
19
20
21
21
21
21
21
21
Guide Contents
Guide Contents
Overview
The Process
Preparing the Images
Finding Images on Flickr
Resizing Photos
PhotoShop
GIMP
ezgif.com
Optimizing Images
Adding to Downloads
Image Location
Markdown File
Header
layout
board_id
title
name
manufacturer
board_url
board_image
downloads_display
features
Body
Purchase Section
Learn More Section
Contribute Section
Submit a Pull Request
Adding to Blinka
Image Location
Markdown File
Header
layout
board_id
title
name
manufacturer
board_url
board_image
download_instructions
downloads_display
blinka
date_added
features
Body
Purchase Section
Learn More Section
Contribute Section
Final File
Submit a Pull Request
Testing Changes Locally
Troubleshooting
My PR has been approved and merged, but my changes aren't showing up
I've waited more than a few minutes and they still aren't showing up
My changes were merged, but the image is wrong or missing
Some of the images are right, but not all of them
There are some Unknown boards showing up in addition to the board I added
© Adafruit Industries https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website Page 2 of 22
21There is an Unknown board and the board I added isn't showing up
© Adafruit Industries https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website Page 3 of 22
Overview
So you've designed a microcontroller board that runs CircuitPython and you would like to show it off to
the world by adding it to the circuitpython.org (https://adafru.it/EFq) website? We can show you how.
Or perhaps you now have Blinka running on your Linux-based Single Board Computer (SBC) and want to
share that to everyone? We can show you how to do that too.
There are two sections where you can add boards. The first is the downloads page for microcontrollers
running CircuitPython and that will not only show off the details of your board, but provide links to
download the latest stable and development releases of CircuitPython.
The other section is the Blinka page which house all of the boards that support Blinka, which is our
CircuitPython library compatibility layer for SBCs and Python 3. This page allows your to display all of the
stats for your board as well as point to a guide for setting up Blinka on your board.
The Process
Either way, the process is about the same. Adding a board to the circuitpython.org website is easy and
only requires three images and one Markdown or MD file per board.
Getting setup is very easy. The first thing you'll need to do is head over to Github and create a fork. If you
would like more information, be sure to check out our Contribute to CircuitPython with Git and
GitHub (https://adafru.it/Dkh) guide.
The repository to create a fork of is https://github.com/adafruit/circuitpython-org (https://adafru.it/Fno).
Once you create a fork, you will need to clone it with git and you will have access to all of the source files
for the website.
Let's continue with preparing our images!
© Adafruit Industries https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website Page 4 of 22
Preparing the Images
To add a board to CircuitPython.org, you will need three sizes of the same image for each board.
1. Small Size Minimum Width of 292 pixels. (Most photos are 293x225)
2. Large Size Minimum Width of 590 pixels. (Most photos are 780x600)
3. Original Size Photo in a Large Size
A good aspect ratio that looks nice for the Original Photo size is 13:10. This is the ratio used for most of
Adafruit's product photos. We will start with finding an image, if you don't already have it, resizing it to the
appropriate size, and optimizing it for the website.
Finding Images on Flickr
Adafruit has many products available on Flickr in high resolution. Most of the photos are in the 13:10
aspect ratio.
1. Go to https://www.flickr.com (https://adafru.it/Fnj)
2. Type "Adafruit Industries" into the search box and click "Search people"
3. Click on Adafruit Industries
Click the Magnifying Glass icon on the right
© Adafruit Industries https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website Page 5 of 22
At the top, type in your Search Term and press enter
Click on a Photo in the Search Results
Verify the Description matches the item that you're looking for
© Adafruit Industries https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website Page 6 of 22
Click the Arrow on the right side and select a size that will be your Original Sized photo
Resizing Photos
Photos can be resized in your favorite photo editor such as PhotoShop or GIMP or via websites such as
ezgif.com
All three images should have the exact same filename.
PhotoShop
PhotoShop is one of the most popular pieces of Photo Editing software by Adobe, however it is not free.
Here are the steps to resize the image in PhotoShop.
1. Open the Original Sized Photo
2. Go to Image→Image Size...
3. Type a width like 780. The height should automatically adjust.
© Adafruit Industries https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website Page 7 of 22
Loading...