From e67bf025e4a521352147c29d0175f31469134407 Mon Sep 17 00:00:00 2001 From: Pete Fotheringham Date: Sun, 27 Oct 2013 08:44:04 +0000 Subject: First contributions add 'Mission' section - wording to be agreed changed by Lars add 'Document Status' section - 'Done', 'New' and 'Coming soon' --- yarn-doc/index.mdwn | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) 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 ------- -- cgit v1.2.1