Welcome!
========

	This directory contains EDB, the Emacs Database.
	EDB was written by Michael Ernst <mernst@theory.lcs.mit.edu>,
	and is being maintained by Thien-Thi Nguyen <ttn@glug.org>.

	EDB homepage: <http://www.glug.org/people/ttn/software/edb/>


Dependencies
============

	GNU make that supports VPATH	-- build/install
	GNU Emacs 21.2 or later		-- build/install/run


Installation
============

	To install EDB, unpack the tarball, change into the resulting
	directory (usually named edb-${VERSION}), and issue the three
	commands:

		./configure
		make
		make check	# optional but recommended
		make install

	This byte-compiles the .el files, and copies .el and .elc files
	to ${sitelisp}/edb, and edb.info to ${infodir}, creating those
	directories first if necessary.  Normally, these variables have
	the values:

		${prefix}	/usr/local
		${datadir}	${prefix}/share
		${sitelisp}	${datadir}/emacs/site-lisp
		${infodir}	${prefix}/info

	To use DIR instead of "/usr/local" for ${prefix} include the
	option `--prefix DIR' to the configure script.  To choose an
	alternate ${sitelisp}, use the option `--with-sitelisp=DIR'.
	You can use the `--help' option to see full details.

	After installation, the unpacked directory can be deleted.

	Note that installation does not place files directly in the
	${sitelisp} directory, but rather a subdirectory named "edb".
	It is assumed there exists the file ${sitelisp}/subdirs.el
	that is responsible for adding ${sitelisp}/edb to the Emacs
	`load-path'.  If this is not the case, you can create one to do
	the job, with contents:

	(if (fboundp 'normal-top-level-add-subdirs-to-load-path)
	    (normal-top-level-add-subdirs-to-load-path))

	This has been verified to work with GNU Emacs 21.3.


Usage
=====

	Use `M-x db-find-file' to start up EDB on a particular database
	file.  Full details are in the documentation, highly recommended
	for both end users and programmers.

	Additionally, the distribution includes a subdir `examples'
	full of code demonstrating various ways of using EDB.


Reporting Bugs
==============

	If you find a problem with EDB that is not explained in the
	documentation, please file a bug report with the maintainer.
	Include EDB version and as concise a test case as possible
	(that reproduces the problem).
