From 41a90b0004ee59a888a824c192696fbcfcce75e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20K=C3=B6hl?= Date: Mon, 20 Nov 2023 08:38:00 +0100 Subject: [PATCH] docs: add remarks for Raspberry Pi 5 --- www/blog/2023-07-23-introducing-rugpi.md | 2 +- www/docs/getting-started.md | 4 ++-- www/docs/guide/index.md | 2 +- www/docs/guide/supported-boards.md | 6 ++++++ 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/www/blog/2023-07-23-introducing-rugpi.md b/www/blog/2023-07-23-introducing-rugpi.md index da14989..e6c3ce4 100644 --- a/www/blog/2023-07-23-introducing-rugpi.md +++ b/www/blog/2023-07-23-introducing-rugpi.md @@ -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). 🚀 diff --git a/www/docs/getting-started.md b/www/docs/getting-started.md index 7088e79..26f87bc 100644 --- a/www/docs/getting-started.md +++ b/www/docs/getting-started.md @@ -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 diff --git a/www/docs/guide/index.md b/www/docs/guide/index.md index e9d894e..5b1aa45 100644 --- a/www/docs/guide/index.md +++ b/www/docs/guide/index.md @@ -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. \ No newline at end of file +This user guide assumes that you already read the [quick-start guide](../getting-started) and know how to build a customized image. \ No newline at end of file diff --git a/www/docs/guide/supported-boards.md b/www/docs/guide/supported-boards.md index 348c155..dc16012 100644 --- a/www/docs/guide/supported-boards.md +++ b/www/docs/guide/supported-boards.md @@ -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.