diff mbox series

[2/2] README: Merge OE-Core and QEMU READMEs into one

Message ID 20260618085133.3756278-2-richard.purdie@linuxfoundation.org
State Accepted, archived
Commit c078ff1b6fd2fc12cc85190b01ab4f631c281565
Headers show
Series [1/2] README.qemu: Update to match current architecture support | expand

Commit Message

Richard Purdie June 18, 2026, 8:51 a.m. UTC 
OE-Core originally had separate READMEs due to the layout with Poky. This
reason no longer exists and we can merge things into one README now which
should make the contribution information easier to find for users.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 README.OE-Core.md | 36 ------------------------------
 README.md         | 57 ++++++++++++++++++++++++++++++++++++++++++++++-
 README.qemu.md    | 19 ----------------
 3 files changed, 56 insertions(+), 56 deletions(-)
 delete mode 100644 README.OE-Core.md
 mode change 120000 => 100644 README.md
 delete mode 100644 README.qemu.md
diff mbox series

Patch

diff --git a/README.OE-Core.md b/README.OE-Core.md
deleted file mode 100644
index 4804e436322..00000000000
--- a/README.OE-Core.md
+++ /dev/null
@@ -1,36 +0,0 @@ 
-OpenEmbedded-Core
-=================
-
-OpenEmbedded-Core is a layer containing the core metadata for current versions
-of OpenEmbedded. It is distro-less (can build a functional image with
-DISTRO = "nodistro") and contains only emulated machine support.
-
-For information about OpenEmbedded, see the OpenEmbedded website:
-<https://www.openembedded.org/>
-
-The Yocto Project has extensive documentation about OE including a reference manual
-which can be found at:
-<https://docs.yoctoproject.org/>
-
-Contributing
-------------
-
-Please refer to our contributor guide here: <https://docs.yoctoproject.org/dev/contributor-guide/>
-for full details on how to submit changes.
-
-For any files containing sorted lists (such as recipe maintainers), please ensure
-alphabetical order is maintained using the C locale. For example, use:
-`LC_ALL=C sort` to sort the list.
-
-As a quick guide, patches should be sent to openembedded-core@lists.openembedded.org
-The git command to do that would be:
-
-```
-git send-email -M -1 --to openembedded-core@lists.openembedded.org
-```
-
-Mailing list:
-<https://lists.openembedded.org/g/openembedded-core>
-
-Source code:
-<https://git.openembedded.org/openembedded-core/>
diff --git a/README.md b/README.md
deleted file mode 120000
index 4d7e9e8b429..00000000000
--- a/README.md
+++ /dev/null
@@ -1 +0,0 @@ 
-README.OE-Core.md
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..92373e4a047
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@ 
+OpenEmbedded-Core
+=================
+
+OpenEmbedded-Core is a layer containing the core metadata for current versions
+of OpenEmbedded. It is distro-less (can build a functional image with
+DISTRO = "nodistro") and contains only emulated machine support.
+
+For information about OpenEmbedded, see the OpenEmbedded website:
+<https://www.openembedded.org/>
+
+The Yocto Project has extensive documentation about OE including a reference manual
+which can be found at:
+<https://docs.yoctoproject.org/>
+
+Contributing
+------------
+
+Please refer to our contributor guide here: <https://docs.yoctoproject.org/dev/contributor-guide/>
+for full details on how to submit changes.
+
+For any files containing sorted lists (such as recipe maintainers), please ensure
+alphabetical order is maintained using the C locale. For example, use:
+`LC_ALL=C sort` to sort the list.
+
+As a quick guide, patches should be sent to openembedded-core@lists.openembedded.org
+The git command to do that would be:
+
+```
+git send-email -M -1 --to openembedded-core@lists.openembedded.org
+```
+
+Mailing list:
+<https://lists.openembedded.org/g/openembedded-core>
+
+Source code:
+<https://git.openembedded.org/openembedded-core/>
+
+QEMU Emulation Targets
+======================
+
+To simplify development, the build system supports building images to
+work with the QEMU emulator in system emulation mode and these machines are
+the ones included in OE-Core. Our support and testing is currently focused
+around the following primary architectures and machine targets:
+
+* ARM (qemuarm + qemuarm64)
+* x86 (qemux86 + qemux86-64)
+* RISC-V (qemuriscv64)
+
+Use of the QEMU images is covered in the Yocto Project Reference Manual.
+The appropriate MACHINE variable value corresponding to the target is given
+in brackets.
+
+OpenEmbedded does also have support for PowerPC (qemuppc/qemuppc64), MIPS
+(qemumips + qemumips64), qemuriscv32 and other less common targets but these
+are not as widely tested.
diff --git a/README.qemu.md b/README.qemu.md
deleted file mode 100644
index bdd44082882..00000000000
--- a/README.qemu.md
+++ /dev/null
@@ -1,19 +0,0 @@ 
-QEMU Emulation Targets
-======================
-
-To simplify development, the build system supports building images to
-work with the QEMU emulator in system emulation mode. Our support and testing
-is currently focused around the following primary architectures and machine
-targets:
-
-* ARM (qemuarm + qemuarm64)
-* x86 (qemux86 + qemux86-64)
-* RISC-V (qemuriscv64)
-
-Use of the QEMU images is covered in the Yocto Project Reference Manual.
-The appropriate MACHINE variable value corresponding to the target is given
-in brackets.
-
-OpenEmbedded does also have support for PowerPC (qemuppc/qemuppc64), MIPS
-(qemumips + qemumips64), qemuriscv32 and other less common targets but these
-are not as widely tested.