|
| 1 | + |
1 | 2 | # CircuitPython organization site |
| 3 | +A more detailed gude for adding a board to CircuitPython can be found in the |
| 4 | +following Adafruit Learn guide: [How to add a New Board to the circuitpython.org website](https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website) |
2 | 5 |
|
3 | 6 | **To add a new board to the site:** |
4 | 7 |
|
5 | 8 | 1. Duplicate `template.md` to `_board/<board id>.md`. |
6 | 9 | 2. Edit `_board/<board id>.md` according to the template's instructions. |
7 | | -3. Provide 3 images. An original high-quality image. A smaller image (300 px width), |
8 | | -and a larger image (700 px width) in each respective directory (assets/images/boards/{small large original}) |
9 | | -and process them in something like https://squoosh.app/ to reduce file size. If |
| 10 | +3. In your `_board/<board id>.md` you will specifigy a `board_image`. Create 3 |
| 11 | +versions of this file, in the following sizes and folder locations: |
| 12 | + |
| 13 | +|Size|File|Dimensions (px)| |
| 14 | +|--|--|--| |
| 15 | +|Original|assets/images/orignal/{board_image}|900px+ width and 4:3 ratio width| |
| 16 | +|||example: 900 x 675| |
| 17 | +|Large|assets/images/large/{board_image}|800 x 600| |
| 18 | +|Small|assets/images/small/{board_image}|300 x 225| |
| 19 | + |
| 20 | +> For more information on preferred images see |
| 21 | +> [Preparing the Images](https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/preparing-the-images) |
| 22 | +> in the Adafruit Learn guide |
| 23 | +
|
| 24 | + |
| 25 | +4. Process the in something like https://squoosh.app/ to reduce file size. If |
10 | 26 | you only have one image, place it in the 'original' folder. |
11 | | -3. Create a pull request with the file changes. |
| 27 | +5. Create a pull request with the file changes. |
12 | 28 |
|
13 | 29 | **To test your changes locally:** |
14 | 30 |
|
|
0 commit comments