From b208804d4c4c9ae88283bbd510d5699e7afc92f5 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Wed, 14 Jul 2021 09:52:46 +0300 Subject: add start of an FAQ Sponsored-by: author --- docs.mdwn | 3 +-- faq.mdwn | 12 ++++++++++++ index.mdwn | 2 +- 3 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 faq.mdwn 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]] — -[[Documentation|docs]] — +[[Documentation|docs]] ([[FAQ]]) — [[Contact]] — [[License]] — [[Blog]] -- cgit v1.2.1