summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-07-14 09:52:46 +0300
committerLars Wirzenius <liw@liw.fi>2021-07-14 09:53:03 +0300
commitb208804d4c4c9ae88283bbd510d5699e7afc92f5 (patch)
tree3c398bbfe5bdf047f9ac201db6518deedba8cebf
parentb4664e22c9a13dd0ca1b8ff2f1f450945262a893 (diff)
downloadsubplot.liw.fi-b208804d4c4c9ae88283bbd510d5699e7afc92f5.tar.gz
add start of an FAQ
Sponsored-by: author
-rw-r--r--docs.mdwn3
-rw-r--r--faq.mdwn12
-rw-r--r--index.mdwn2
3 files changed, 14 insertions, 3 deletions
diff --git a/docs.mdwn b/docs.mdwn
index f225e6a..f58e14f 100644
--- a/docs.mdwn
+++ b/docs.mdwn
@@ -1,8 +1,7 @@
[[!meta title="Documentation"]]
-There is a [[tutorial]], which is currently not working, until the
-software has been written.
+There is a [[tutorial]] and an [[FAQ]] (with frequently asked questions).
See also Subplot's own [subplot][].
diff --git a/faq.mdwn b/faq.mdwn
new file mode 100644
index 0000000..7ef6737
--- /dev/null
+++ b/faq.mdwn
@@ -0,0 +1,12 @@
+[[!meta title="FAQ or Frequently Asked Questions"]]
+
+
+# How does Subplot differ from Cucumber?
+
+[Cucumber]: https://en.wikipedia.org/wiki/Cucumber_(software)
+[Gherkin]: https://en.wikipedia.org/wiki/Cucumber_(software)#Gherkin_language
+
+[Cucumber][] is a tool for running test suites written in [Gherkin][],
+whereas Subplot is a tool for typesetting technical documentation
+which happens to, as a side effect, output test suites based on a
+Gherkin-like language embedded in the document
diff --git a/index.mdwn b/index.mdwn
index 65da7e5..3403cec 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -1,7 +1,7 @@
[[!meta title="Subplot"]]
[[Download]] &mdash;
-[[Documentation|docs]] &mdash;
+[[Documentation|docs]] ([[FAQ]]) &mdash;
[[Contact]] &mdash;
[[License]] &mdash;
[[Blog]]