summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Fotheringham <pete.fotheringham@codethink.co.uk>2013-10-27 08:44:04 +0000
committerPete Fotheringham <pete.fotheringham@codethink.co.uk>2013-10-27 08:44:04 +0000
commite67bf025e4a521352147c29d0175f31469134407 (patch)
treebe799646f7ce92381a6248db29c248127d325a7d
parent0aad99d630ed073c7d071906f81c8aeba8196dc2 (diff)
downloadcmdtest-e67bf025e4a521352147c29d0175f31469134407.tar.gz
First contributions
add 'Mission' section - wording to be agreed changed by Lars add 'Document Status' section - 'Done', 'New' and 'Coming soon'
-rw-r--r--yarn-doc/index.mdwn38
1 files changed, 38 insertions, 0 deletions
diff --git a/yarn-doc/index.mdwn b/yarn-doc/index.mdwn
index 7deaffb..620572d 100644
--- a/yarn-doc/index.mdwn
+++ b/yarn-doc/index.mdwn
@@ -6,6 +6,44 @@ Yarn
FIXME: This will become a manual for writing test suites in yarn. It
is currently not yet written.
+Mission
+-------
+This manual will provide all the information needed by Yarn users to enable
+them to use Yarn effectively in their development projects.
+
+The information will be
+
+* easy to find
+* easy to navigate
+* easy to use
+
+The information will include details of
+
+* how to perform certain tasks
+* why things are done in particular ways
+
+Document Status
+---------------
+
+What's Done
+===========
+
+* Outline
+
+What's New
+==========
+
+* Mission
+* this Document Status section
+
+What's Next
+===========
+
+* Test language specification (from README.yarn)
+* `yarn`'s command line
+* How to embed `yarn` in Markdown
+
+
Outline
-------