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 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. If you haven't yet added your board to CircuitPython itself, first follow the instructions in the How to Add a New Board to CircuitPython guide.

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 guide.

The repository to create a fork of is https://github.com/adafruit/circuitpython-org. 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!

This guide was first published on Jul 24, 2019. It was last updated on Mar 18, 2024.

This page (Overview) was last updated on Mar 08, 2024.

Text editor powered by tinymce.