From fdb9d60f64adadb6a6caf47d05770576b479afba Mon Sep 17 00:00:00 2001 From: Josef Holzmayr Date: Fri, 25 Feb 2022 13:14:10 +0100 Subject: [PATCH 1/3] README: add section "Requisites" Changelog: clarify supported development platforms Defining Ubuntu 18.04 x86_64 as the officially supported host platform and clarifying requirements for local storage Signed-off-by: Josef Holzmayr --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e06241b..8f7bcea 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,19 @@ on your device. ![Mender logo](https://github.com/mendersoftware/mender/raw/master/mender_logo.png) +## Requisites + +`mender-convert` is supported on the following development platform(s): + + - Ubuntu 18.04 x86, 64bit + +Other platforms may work, but are not under active testing. Patches to add additional +platforms or fix compatibility issues are welcome. + +The storage used during the process, specifically the work directories (usually below the clone of +`mender-convert`) and the output directory should be located on local, Unix-style filesystem. +Using network storage or emulated filesystems might cause permission or owner issues. + ## Getting started From a8df0abd02681b1dfae11af098b83b0920d7cfd0 Mon Sep 17 00:00:00 2001 From: Josef Holzmayr Date: Fri, 25 Feb 2022 14:13:47 +0100 Subject: [PATCH 2/3] README: note 32bit-compatibility and Raspbian Changelog: clarify Raspbian compatibility Signed-off-by: Josef Holzmayr --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 8f7bcea..b824f2c 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,11 @@ For more detailed information about `mender-convert` please visit the ### Prepare image and configuration +*Only 32bit-Images are supported at the moment!* + +The following steps give a quick start using Raspbian. For a more detailed guide, +especially concerning version compatibilities, please visit [the the corresponding thread](https://hub.mender.io/t/raspberry-pi-3-model-b-b-raspbian/140) on the Mender Hub. + Download the raw Raspberry Pi disk image into a subdirectory input: ```bash From 86c47bd633561b27a1bd407a970ab30ee6025d97 Mon Sep 17 00:00:00 2001 From: Josef Holzmayr Date: Mon, 28 Feb 2022 16:09:54 +0100 Subject: [PATCH 3/3] README: add compatibility tables for configurations Changelog: title The configuration files are only meant to work on specific combinations of board+OS. These are added verbatim in order to avoid confusion. Signed-off-by: Josef Holzmayr --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b824f2c..0a967a6 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,35 @@ For more detailed information about `mender-convert` please visit the [Debian family](https://docs.mender.io/artifacts/debian-family) section in [the Mender documentation](https://docs.mender.io/). +## Included configurations -### Prepare image and configuration +### Core configurations + +These configurations are officially supported. + +| Configuration | Supported OS / hardware | +| :------------ | :---------------------- | +| generic_x86-64_config | Generic x86, 64bit distribtion *use this as a starting point only!* | +| raspberrypi0w_config | RaspberryPi 0w, Raspbian 32bit | +| raspberrypi3_config | RaspberryPi 3, Raspbian 32bit | +| raspberrypi4_config | RaspberryPi 4, Raspbian 32bit | +| raspberrypi4_ubuntu_config | RaspberryPi 4, Ubuntu 32bit | + +### Contributed configurations -*Only 32bit-Images are supported at the moment!* +These configurations have been submitted by community contributors. + +| Configuration | Supported OS / hardware | +| :------------ | :---------------------- | +| beaglebone_black_debian_emmc_config | BeagleBone Black 4GB, Debian 32bit on internal eMMC storage | +| beaglebone_black_debian_sdcard_config | BeagleBone Black, Debian 32bit on external SD card storage | +| comfile_pi_config | Comfile Pi, Raspbian 32bit | +| rockpro64_emmc_config | RockPro64, Debian 32bit on internal eMMC storage | +| rockpro64_sd_config | BeagleBone Black, Debian 32bit on external SD card storage | + +## Example usage: Raspberry Pi 3, Raspbian 32bit + +### Prepare image and configuration The following steps give a quick start using Raspbian. For a more detailed guide, especially concerning version compatibilities, please visit [the the corresponding thread](https://hub.mender.io/t/raspberry-pi-3-model-b-b-raspbian/140) on the Mender Hub.