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

Update with suggested changes

Browse source
This commit is contained in:
Patrick 2022-07-17 17:39:09 -07:00
parent d6d45d3160
commit c6e7ca3af2
1 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -7,7 +7,7 @@ following Adafruit Learn guide: [How to add a New Board to the circuitpython.org
1. Duplicate `template.md` to `_board/<board id>.md`. 1. Duplicate `template.md` to `_board/<board id>.md`.
2. Edit `_board/<board id>.md` according to the template's instructions. 2. Edit `_board/<board id>.md` according to the template's instructions.
3. In your `_board/<board id>.md` you will specifigy a `board_image`. Create 3 3. In your `_board/<board id>.md` you will specify a `board_image`. Create 3
versions of this file, in the following sizes and folder locations: versions of this file, in the following sizes and folder locations:
|Size|File|Dimensions (px)| |Size|File|Dimensions (px)|
@ -17,13 +17,10 @@ versions of this file, in the following sizes and folder locations:
|Large|assets/images/large/{board_image}|800 x 600| |Large|assets/images/large/{board_image}|800 x 600|
|Small|assets/images/small/{board_image}|300 x 225| |Small|assets/images/small/{board_image}|300 x 225|
> For more information on preferred images see > For more information on preferred images or if you prefer or must use 13:10 see
> [Preparing the Images](https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/preparing-the-images) > [Preparing the Images](https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/preparing-the-images)
> in the Adafruit Learn guide > in the Adafruit Learn guide
4. Process the in something like https://squoosh.app/ to reduce file size. If
you only have one image, place it in the 'original' folder.
5. Create a pull request with the file changes. 5. Create a pull request with the file changes.
**To test your changes locally:** **To test your changes locally:**