From 5d1fe2fab365af65ee4c36e1f61501983f98d177 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 1 Dec 2019 10:32:22 +0200 Subject: Change: update README to be a little clearer Also, rename to README.md so code hosting sites render it as HTML. --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 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 . -- cgit v1.2.1