Skip to content

Commit 7322bad

Browse files
Add docs on adding a new board to the core, too
1 parent 6afd326 commit 7322bad

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/contrib.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,27 @@ Try and only change one thing per pull request. That makes it easier to
3333
review and prioritize. Opening up a separate PR per change also helps keep
3434
track of them when release messages are generated.
3535

36+
Adding a New Board
37+
------------------
38+
39+
To add a new RP2040 board you will need to update the ``tools/makeboards.py``
40+
script. Do *NOT* manually edit ``boards.txt``, that file is machine generated.
41+
You will need to add a ``MakeBoard`` call at the end of the file. Please be sure
42+
to add your board so that it sorts alphabetically, starting with the company name
43+
and then the board name. Otherwise it is hard to find a specific board in the menu.
44+
45+
Run ``python3 tools/makeboards.py`` to update the ``boards.txt`` file and generate
46+
a Platform.IO JSON file in the ``tools/json`` directory.
47+
48+
In your ``git commit`` be sure to add the newly generated ``tools/json/XXX.json``
49+
file as well as the modified ``makeboards`` script and ``boards.txt`` and the
50+
Arduino packaging JSON ``package/package_pico_index.template.json``. You should
51+
also add a note in the ``README.md`` file listing your new board.
52+
53+
Submit the updated commit as a PR and, if all goes well, your board will be in
54+
on the next core release.
55+
56+
3657
Porting Libraries and Applications to the Core
3758
----------------------------------------------
3859

0 commit comments

Comments
 (0)