diff mbox series

[meta-lts-mixins,scarthgap/go,v2,34/35] readme: update to markdown format

Message ID 20251119150522.15477-35-peter.marko@siemens.com
State New
Headers show
Series initial scarthgap/go version | expand

Commit Message

Marko, Peter Nov. 19, 2025, 3:05 p.m. UTC 
From: Peter Marko <peter.marko@siemens.com>

Changes are inspired by scarthgap/rust README.md file.

Signed-off-by: Peter Marko <peter.marko@siemens.com>
---
 README    | 15 ---------------
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 15 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md
diff mbox series

Patch

diff --git a/README b/README
deleted file mode 100644
index 1aa3809..0000000
--- a/README
+++ /dev/null
@@ -1,15 +0,0 @@ 
-"Mixin" layer for adding latest Go toolchain versions into the Yocto Project LTS.
-
-At the time Scarthgap was released in April 2024, Go 1.22 was the latest version
-and officially Scarthgap supports only that. This thin special-purpose mixin
-layer is meant to address this issue by backporting Go recipes from the master
-branch of openembedded-core.
-
-The patches can be backport from openembedded-core with:
-
- git -C ../openembedded-core format-patch --stdout -1 origin/master meta/recipes-devtools/go | \
- git am --signoff -p4 --directory=recipes-devtools/go
-
-Maintainers:
-Jose Quaresma <jose.quaresma@foundries.io>
-Peter Marko <peter.marko@siemens.com>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..47cc7b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@ 
+meta-mixins-lts - scarthgap/go
+==============================
+
+"Mixin" layer for adding latest Go toolchain versions into the Yocto Project LTS.
+
+At the time Scarthgap was released in April 2024, Go 1.22 was the latest version
+and officially Scarthgap supports only that. This thin special-purpose mixin
+layer is meant to address this issue by backporting Go recipes from the master
+branch of openembedded-core.
+
+Dependencies
+------------
+
+This layer depends on:
+
+- URI: git://github.com/openembedded/openembedded-core.git  
+  layers: meta  
+  branch: scarthgap
+
+Contributing
+------------
+
+The patches can be backported from openembedded-core with:
+
+ git -C ../openembedded-core format-patch --stdout -1 origin/master meta/recipes-devtools/go | \
+ git am --signoff -p4 --directory=recipes-devtools/go
+
+The yocto-patches mailinglist (yocto-patches@lists.yoctoproject.org) is used
+for questions, comments and patch review. It is subscriber only, so please
+register before posting.
+
+Send pull requests to yocto-patches@lists.yoctoproject.org with
+'[meta-lts-mixins][scarthgap/go]' in the subject.
+
+When sending single patches, please use something like:
+git send-email -M -1 --to=yocto-patches@lists.yoctoproject.org --subject-prefix='meta-lts-mixins][scarthgap/go][PATCH'
+
+Maintenance
+-----------
+
+Layer maintainers:
+* Jose Quaresma <jose.quaresma@foundries.io>
+* Peter Marko <peter.marko@siemens.com>