From 4ac5feb6bbf9e4609377464c114d5d5330344090 Mon Sep 17 00:00:00 2001
From: Joe Rickerby <joerick@mac.com>
Date: Sat, 12 Dec 2020 12:38:01 +0000
Subject: [PATCH] Add note about generated content, update paths

---
 README.md       | 8 +++++---
 bin/projects.py | 7 ++++---
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 39c3be8f..e0fae8cf 100644
--- a/README.md
+++ b/README.md
@@ -105,7 +105,9 @@ For more information, including how to build on GitHub Actions, Appveyor, Azure
 Options
 -------
 
-<!-- START bin/project.py -->
+<!-- START bin/projects.py -->
+
+<!-- this section is generated by bin/projects.py. Don't edit it directly, instead, edit docs/data/projects.yml -->
 
 | Name                              | CI | OS | Notes |
 |-----------------------------------|----|----|:------|
@@ -221,9 +223,9 @@ Options
 <!-- xmlstarlet: 7, last pushed 0 days ago -->
 <!-- pybind11:scikit_build_example: 1, last pushed 25 days ago -->
 
-<!-- END bin/project.py -->
+<!-- END bin/projects.py -->
 
-> Add your repo here! Send a PR, adding your information to `bin/projects.yml`.
+> Add your repo here! Send a PR, adding your information to `docs/data/projects.yml`.
 >
 > <sup>I'd like to include notes here to indicate why an example might be interesting to cibuildwheel users - the styles/technologies/techniques used in each. Please include that in future additions!</sup>
 
diff --git a/bin/projects.py b/bin/projects.py
index 87397057..e478c6ae 100755
--- a/bin/projects.py
+++ b/bin/projects.py
@@ -156,10 +156,11 @@ def projects(
         print(output)
     else:
         text = readme.read()
-        start_str = "<!-- START bin/project.py -->\n"
+        start_str = "<!-- START bin/projects.py -->\n"
         start = text.find(start_str)
-        end = text.find("<!-- END bin/project.py -->\n")
-        new_text = f"{text[:start + len(start_str)]}\n{output}\n{text[end:]}"
+        end = text.find("<!-- END bin/projects.py -->\n")
+        generated_note = f'<!-- this section is generated by bin/projects.py. Don\'t edit it directly, instead, edit {input.name} -->'
+        new_text = f"{text[:start + len(start_str)]}\n{generated_note}\n\n{output}\n{text[end:]}"
 
         readme.seek(0)
         readme.write(new_text)