[README.md] Add "do not edit" comment

Closes #45
google · Aug 3, 2023 · f60615d · f60615d
1 parent 761ff2d
commit f60615d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,10 @@
 <!-- Copyright 2022 The Fuchsia Authors. All rights reserved.
 Use of this source code is governed by a BSD-style license that can be
-found in the LICENSE file. -->
+found in the LICENSE file.
+
+WARNING: DO NOT EDIT THIS FILE. It is generated automatically. Edits should be
+made in the doc comment on `src/lib.rs` or in `generate-readme.sh`.
+-->
 
 # zerocopy
 

diff --git a/generate-readme.sh b/generate-readme.sh
@@ -10,10 +10,14 @@ COPYRIGHT_HEADER=$(mktemp)
 BODY=$(mktemp)
 DISCLAIMER_FOOTER=$(mktemp)
 
-cat > $COPYRIGHT_HEADER <<EOF
+cat > $COPYRIGHT_HEADER <<'EOF'
 <!-- Copyright 2022 The Fuchsia Authors. All rights reserved.
 Use of this source code is governed by a BSD-style license that can be
-found in the LICENSE file. -->
+found in the LICENSE file.
+
+WARNING: DO NOT EDIT THIS FILE. It is generated automatically. Edits should be
+made in the doc comment on `src/lib.rs` or in `generate-readme.sh`.
+-->
 
 EOF
 
@@ -28,7 +32,7 @@ EOF
 # characters to convert them to non-link code snippets.
 cargo readme | sed 's/\[\(`[^`]*`\)]/\1/g' > $BODY
 
-cat > $DISCLAIMER_FOOTER <<EOF
+cat > $DISCLAIMER_FOOTER <<'EOF'
 
 ## Disclaimer