summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2019-12-01 10:32:22 +0200
committerLars Wirzenius <liw@liw.fi>2019-12-01 10:32:22 +0200
commit5d1fe2fab365af65ee4c36e1f61501983f98d177 (patch)
treec2245b8b8fc6ab48f1703b2bda4cb3243d740847 /README.md
parentc37e13bcf4219771f0895988e66f0619891d3e77 (diff)
downloadsubplot-5d1fe2fab365af65ee4c36e1f61501983f98d177.tar.gz
Change: update README to be a little clearer
Also, rename to README.md so code hosting sites render it as HTML.
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ccbb52b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Subplot
+
+Document acceptance criteria of software and systems, and how they are
+verified.
+
+**Status:** Subplot is very much not finished and is not usable yet.
+We're working on a minimum viable product which can be used for a
+simple web API project.
+
+## When all stakeholders really need to understand acceptance criteria
+
+Subplot is a set of tools for specifying, documenting, and
+implementing automated acceptance tests for systems and software.
+Subplot tools aim to produce a human-readable document of acceptance
+criteria and a program that automatically tests a system against those
+criteria. The goal is for every stakeholder in a project to understand
+the project’s acceptance criteria and how they’re verified.
+
+See <https://subplot.liw.fi/> for the home page.
+
+# Legalese
+
+Copyright 2019 Lars Wirzenius
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.