Skip to content

Commit

Permalink
docs: add remarks for Raspberry Pi 5
Browse files Browse the repository at this point in the history
  • Loading branch information
koehlma committed Nov 20, 2023
1 parent 645baf1 commit 41a90b0
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 4 deletions.
2 changes: 1 addition & 1 deletion www/blog/2023-07-23-introducing-rugpi.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ For further details, read the [user guide](/docs/guide/) and checkout [the sourc
### Try it Today!

We invite you to try Rugpi.
Checkout [the quick start guide](/docs/getting-started) to built your first image and share your recipes, questions, projects, ideas, and suggestions by opening [discussions on GitHub](https://github.com/silitics/rugpi/discussions). 🚀
Checkout [the quick-start guide](/docs/getting-started) to built your first image and share your recipes, questions, projects, ideas, and suggestions by opening [discussions on GitHub](https://github.com/silitics/rugpi/discussions). 🚀
4 changes: 2 additions & 2 deletions www/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ sidebar_position: 1
# Getting Started 🚀

Rugpi consists of two components, _Rugpi Bakery_ for building customized images, and _Rugpi Ctrl_ for maintaining and managing a Rugpi system.
This quick start guide takes you through the steps necessary to build a custom Rugpi image with Rugpi Bakery.
This quick-start guide takes you through the steps necessary to build a custom Rugpi image with Rugpi Bakery.

⚠️ **Note that Rugpi currently only supports 64-bit Raspberry Pi 4/5 and Compute Module 4.**
The template assumes that you are building an image for Raspberry Pi 4.
This quick-start guide assumes that you are building an image for Raspberry Pi 4.
For further details, please read the [Supported Boards](./guide/supported-boards.md) section of the user guide.

## Building an Image
Expand Down
2 changes: 1 addition & 1 deletion www/docs/guide/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# User Guide

This user guide assumes that you already read the [quick start guide](../getting-started) and know how to build a customized image.
This user guide assumes that you already read the [quick-start guide](../getting-started) and know how to build a customized image.
6 changes: 6 additions & 0 deletions www/docs/guide/supported-boards.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ For further details, see [issue #4](https://github.com/silitics/rugpi/issues/4).
Raspberry Pi OS releases based on Debian Bullseye and Bookworm are supported.


### Raspberry Pi 5

If you are using the quick-start template, please remove the option `include_firmware = "pi4"` from `rugpi-bakery.toml`.
This option will include the bootloader update for Raspberry Pi 4 (see bellow).
Updating the bootloader is not necessary for Raspberry Pi 5, as it already comes with the `tryboot` feature out-of-the-box.

### Raspberry Pi 4 and Compute Module 4

The bootloader version shipped with Raspberry Pi 4 and Compute Module 4 does not support the `tryboot` feature out-of-the-box.
Expand Down

0 comments on commit 41a90b0

Please sign in to comment.