diff mbox series

[2/2] deduplicate README

Message ID 20250605-readme-contrib-v1-2-c51b8cc57b7a@cherry.de
State Accepted
Headers show
Series README: fix contribution instructions when included in poky | expand

Commit Message

Quentin Schulz June 5, 2025, 2:10 p.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

Having a README at the root of the repo is a good practice so we should
keep it. However, it contains information that is now duplicated in
documentation/README. Additionally, this file isn't included in poky
while what's under documentation/ directory is.

Avoid having to maintain both by simply making the root README into a
symlink to documentation/README.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 README | 32 +-------------------------------
 1 file changed, 1 insertion(+), 31 deletions(-)
diff mbox series

Patch

diff --git a/README b/README
deleted file mode 100644
index 88d7fc55305e060729dac740f6cc49c25e7d4ed2..0000000000000000000000000000000000000000
--- a/README
+++ /dev/null
@@ -1,31 +0,0 @@ 
-Yocto Project Documentation
-===========================
-
-This repository contains documentation materials for a variety of the Yocto
-Project components. In particular see the README file under documentation/.
-
-An online version of the documentation can be found at:
-    https://docs.yoctoproject.org
-
-Contributing
-============
-
-Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
-for full details on how to submit changes.
-
-As a quick guide, patches should be sent to docs@lists.yoctoproject.org
-The git command to do that would be:
-
-     git send-email -M -1 --to docs@lists.yoctoproject.org
-
-The 'To' header can be set as default for this repository:
-
-     git config sendemail.to docs@lists.yoctoproject.org
-
-Now you can just do 'git send-email origin/master..' to send all local patches.
-
-Read the documentation/README and documentation/standards.md files
-for rules to follow when contributing to the documentation.
-
-Git repository: https://git.yoctoproject.org/yocto-docs
-Mailing list: docs@lists.yoctoproject.org
diff --git a/README b/README
new file mode 120000
index 0000000000000000000000000000000000000000..c59facf2e91b1f176ae96669b0d89b9732645d3e
--- /dev/null
+++ b/README
@@ -0,0 +1 @@ 
+documentation/README
\ No newline at end of file