external/bsd/atf/dist/doc/readme.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.1//EN"
   3                   "http://docbook.org/xml/simple/1.1/sdocbook.dtd">
   4
   5 <article>
   6
   7 <articleinfo>
   8   <title>Basic information</title>
   9
  10   <author>
  11     <firstname>Julio</firstname>
  12     <surname>Merino</surname>
  13     <affiliation>
  14       <orgname>The NetBSD Foundation</orgname>
  15     </affiliation>
  16   </author>
  17 </articleinfo>
  18
  19 <section id="introduction">
  20
  21 <title>Introduction</title>
  22
  23 <para>The Automated Testing Framework (ATF) is a collection of libraries
  24 and utilities designed to ease unattended application testing in the hands
  25 of developers and end users of a specific piece of software.</para>
  26
  27 <para>As regards developers, ATF provides the necessary means to easily
  28 create test suites composed of multiple test programs, which in turn are a
  29 collection of test cases.  It also attempts to simplify the debugging of
  30 problems when these test cases detect an error by providing as much
  31 information as possible about the failure.</para>
  32
  33 <para>As regards users, it simplifies the process of running the test
  34 suites and, in special, encourages end users to run them often: they do not
  35 need to have source trees around nor any other development tools installed
  36 to be able to certify that a given piece of software works on their machine
  37 as advertised.</para>
  38
  39 </section>
  40
  41 <section id="docs">
  42
  43 <title>Other documents</title>
  44
  45 <itemizedlist>
  46
  47 <listitem><para><filename>AUTHORS</filename>: List of authors and
  48 contributors for this project.</para></listitem>
  49
  50 <listitem><para><filename>COPYING</filename>: License
  51 information.</para></listitem>
  52
  53 <listitem><para><filename>INSTALL</filename>: Compilation and installation
  54 instructions.  These is not the standard document shipped with many
  55 packages, so be sure to read it for things that are specific to ATF's
  56 build.</para></listitem>
  57
  58 <listitem><para><filename>NEWS</filename>: List of major changes between
  59 formal, published releases.</para></listitem>
  60
  61 </itemizedlist>
  62
  63 </section>
  64
  65 <section id="contributing">
  66
  67 <title>Contributing</title>
  68
  69 <para>If you are planning to contribute code to the project, be absolutely
  70 sure to read doc/hacking.txt first.</para>
  71
  72 </section>
  73
  74 </article>