aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBen Elliston <bje@gnu.org>2005-12-24 05:58:14 +0000
committerBen Elliston <bje@gnu.org>2005-12-24 05:58:14 +0000
commit1c8f04ddc541e7e292fcb1b234994d3d2b701b56 (patch)
treeb7e9350d7ffc518d93a7f70b503b15484c4416ca /README
parent185d0cc57e0636b8e75e009810a7f21adcf76f79 (diff)
* README: Rewrite.
Diffstat (limited to 'README')
-rw-r--r--README103
1 files changed, 39 insertions, 64 deletions
diff --git a/README b/README
index 33322d0..ab0fe72 100644
--- a/README
+++ b/README
@@ -1,78 +1,53 @@
-DejaGnu is a framework for testing other programs. Its purpose is to
-provide a single front end for all tests. Beyond this, DejaGnu offers
-several advantages for testing:
-
- - The flexibility and consistency of the DejaGnu framework
- make it easy to write tests for any program.
+Introduction
+------------
- - DejaGnu provides a layer of abstraction which makes all
- tests (if correctly written) portable to any host or target
- where a program must be tested. For instance, a test for
- GDB can run (from any Unix based host) on any target
- architecture supported by DejaGnu. Currently DejaGnu runs
- tests on several single board computers, whose operating
- software ranges from just a boot monitor to a full-fledged,
- Unix-like realtime OS.
-
- - DejaGnu is written in expect, which in turn uses Tcl
- (Tool command language). The framework comprises two parts:
- the testing framework and the testsuites themselves. Tests
- are usually written in expect using Tcl.
-
-If you think you have found a bug in DejaGnu, then please send a bug
-report according to the guidelines outlined at:
+Welcome to DejaGnu!
- <http://www.gnu.org/software/dejagnu/#bug>
-
-
- How To Configure and Build
+DejaGnu is a framework for testing other programs. Its purpose is to
+provide a single front-end for all tests. Beyond this, DejaGnu offers
+several advantages for testing:
- To build DejaGnu, run the ``configure'' script here, e.g.:
+ * The flexibility and consistency of the DejaGnu framework make it
+ easy to write tests for any program.
- ./configure MYHOSTTYPE
+ * DejaGnu provides a layer of abstraction which makes all tests
+ portable to any host or target where a program must be tested.
+ For instance, a test for GDB can run (from any UNIX based host)
+ on any target architecture supported by DejaGnu. DejaGnu has
+ run tests on several single board computers, whose operating
+ software ranges from a boot monitor to a fully-fledged,
+ UNIX-like realtime OS.
-followed by running ``make''. (MYHOSTTYPE is a name for your host computer,
-for instance "sun4". You can use the script ``config.sub'' to test whether
-a name is recognized; if it is, config.sub translates it to a triplet
-specifying CPU, vendor, and OS.) This is used when you plan to
-configure and build in the source tree.
+ * DejaGnu is written in Expect, which in turn uses Tcl (Tool
+ command language). The framework comprises two parts: the
+ testing framework and the testsuites themselves. Tests are
+ usually written in Tcl and distributed with the programs, not
+ with DejaGnu.
- If you use a separate tree for object files, (the recommended way),
-then the --srcdir option must also be specified. This would also
-require that the configure script be run from the top level directory.
+Installation
+------------
- PATH/configure MYHOSTYPE
+For detailed instructions on installing DejaGnu, see the INSTALL file.
-where PATH is is the directory that the contains the sources.
+Reporting bugs
+--------------
- To configure it so it gets installed somewhere other than the
-default of /usr/local, use the --prefix option.
-
- configure MYHOSTYPE --prefix [PATH]
+If you think you have found a bug in DejaGnu, then please send a bug
+report. Guidelines for reporting bugs can be found at:
-where PATH is the prefix used to install the programs.
+ http://www.gnu.org/software/dejagnu/#bug
- The configure testing and building will use the native compiler "cc"
-on your host machine. To change which compiler gets used (like gcc)
-set a the variable "CC" in your environment to point to it.
-
- For csh users: "setenv CC gcc"
- For bourne shell users: "CC=gcc;export CC"
+Documentation
+-------------
- Then when you compile, use "make CC=$CC".
+The DejaGnu documentation is written in Docbook/XML. The Makefile
+does not render the documentation into other formats by default, as
+this requires a range of Docbook packages to be installed. The
+intention is that this will be done by the maintainers when a release
+is made. HTML, RTF, PostScript and PDF versions of the current user
+manual are kept on the web at:
-See /usr/doc/dejagnu-$version/overview/book1.html or
-/usr/doc/dejagnu-$version/overview.ps for for more details.
+ http://www.gnu.org/software/dejagnu/#documentation
- As DejaGnu is a Tcl program, there is little to build. However, the
-documentation is not built by default. Use these targets:
-"make overview.html" - Generate the html formatted documentation from
- the SGML source.
-"make overview.ps" - Generate the Postscript formatted documentation from
- the SGML source.
-"make overview.pdf" - Generate the PDF formatted documentation from
- the SGML source.
-"make install" - This installs DejaGnu based on the --prefix option
- when configuring. Otherwise it defaults to
- /usr/local. See the DejaGnu manual for more
- information on installation.
+Info documentation is installed on a system as part of the
+installation process. You can read this by typing "info dejagnu".