Update README.md

openjournals · Sep 11, 2024 · 6158375 · 6158375
1 parent 1f1125e
commit 6158375
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/test/README.md b/test/README.md
@@ -8,3 +8,11 @@ using the `diff` command:
 2. Crossref XML (`crossref`)
 3. Preprint LaTeX (`preprint`)
 4. PDF (`pdf`), though note this is a binary comparison
+
+The _draft_ golden standard files are in the [expected-draft](expected-draft) folder while
+the _production_ golden standard files are in the [expected-pub](expected-pub) folder.
+
+If you make updates to the underlying [paper.md](../example/paper.md) file in the `/examples`
+folder, you'll need to update at minimum the preprint and PDF. If you update the metadata
+in the `paper.md` or make changes to the templates, you might also have to update the JATS
+and Crossref XML files.