summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-06-06 11:34:18 +0300
committerLars Wirzenius <liw@liw.fi>2021-06-06 11:34:18 +0300
commit742849cdf2bcc6f1e3f614b9d4fd3a03d699064b (patch)
tree4e6178d1cca5a22e9163d28abec4b29af9029f07
parentb283967578389d7f53915addeeb16abb3329cd10 (diff)
downloadsubplot-742849cdf2bcc6f1e3f614b9d4fd3a03d699064b.tar.gz
docs: add metadata titles to README, CONTRIBUTING
I've changed my personal CI to build all .md files with Subplot, so that we can publish typeset versions. This fails on README.md and CONTRIBUTING.md, because they lack a title. Add them. Sponsored-by: author
-rw-r--r--CONTRIBUTING.md4
-rw-r--r--README.md4
2 files changed, 7 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bc3c3de..58a76f9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,7 @@
+---
+title: Contributing to Subplot
+...
+
We would love for you to contribute to the Subplot project, in any way
or form that is good for you. Here are some suggestions to make it as
easy as possible for us to incorporate your contribution. However, you
diff --git a/README.md b/README.md
index d0fbbdb..5110c36 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# Subplot
+---
+title: Subplot README
+...
Capture and communicate acceptance criteria for software and systems,
and how they are verified, in a way that's understood by all project