Document use of "DG_" and "DG__" prefixes in dejagnu.h
[dejagnu.git] / README
blobd2aa6d80097ff09e7ec8ab663a1deb869628682f
1 Introduction
2 ------------
4 Welcome to DejaGnu!
6 DejaGnu is a framework for testing other programs. Its purpose is to
7 provide a single front-end for all tests.  Beyond this, DejaGnu offers
8 several advantages for testing:
10     * The flexibility and consistency of the DejaGnu framework make it
11       easy to write tests for any program.
13     * DejaGnu provides a layer of abstraction which makes all tests
14       portable to any host or target where a program must be tested.
15       For instance, a test for GDB can run (from any UNIX based host)
16       on any target architecture supported by DejaGnu.  DejaGnu has
17       run tests on several single board computers, whose operating
18       software ranges from a boot monitor to a fully-fledged,
19       UNIX-like realtime OS.
21     * DejaGnu is written in Expect, which in turn uses Tcl (Tool
22       command language).  The framework comprises two parts: the
23       testing framework and the testsuites themselves.  Tests are
24       usually written in Tcl and distributed with the programs, not
25       with DejaGnu.
27 Installation
28 ------------
30 For detailed instructions on installing DejaGnu, see the INSTALL file.
32 Reporting bugs
33 --------------
35 If you think you have found a bug in DejaGnu, then please send a bug
36 report.  Guidelines for reporting bugs can be found at:
38     http://www.gnu.org/software/dejagnu/#bug
40 Documentation
41 -------------
43 The DejaGnu documentation is written in Texinfo. HTML and PDF versions
44 of the current user manual are kept at:
46     http://www.gnu.org/software/dejagnu/#documentation
48 GNU Info documentation is installed as part of the installation
49 process.  You can read this by typing "info dejagnu".