VHDL Mode Installation Guide (Unix and Windows)
===============================================

  - Prerequisites
  - Unix
  - Windows 95 & NT
  - Patches
  - XEmacs


Prerequisites
-------------

  - GNU Emacs 20 or higher
  - XEmacs 20 or higher


Unix
----

  1. a) Local installation:
        Put `vhdl-mode.el' and `vhdl-mode.elc' in an arbitrary directory
        and add the following line to your Emacs start-up file (`.emacs').

(setq load-path (cons (expand-file-name "<directory-name>") load-path))

     b) Global installation:
        Put `vhdl-mode.el' and `vhdl-mode.elc' in the `site-lisp' directory
        of your Emacs installation.

  2. a) Local installation (not required for GNU Emacs 20 and higher):
        Add the following lines to your Emacs start-up file (`.emacs').

;;;
;;; VHDL mode
;;;
(autoload 'vhdl-mode "vhdl-mode" "VHDL Mode" t)
(setq auto-mode-alist (cons '("\\.vhdl?\\'" . vhdl-mode) auto-mode-alist))

     b) Global installation (not required for GNU Emacs 20 and higher):
        Put `site-start.el' in the `site-lisp' directory of your Emacs
        installation (or add its contents to an already existing
        `site-start.el' file).

  3. Global installation only:

     Adapt the site-wide customizations for VHDL Mode to your needs in the
     `site-start.el' file (i.e. add the required variable customizations to the
     function `custom-set-variables').

  4. Install required patches (see Patches section).


Windows 95 & NT  (by Kai Cheng <kai.cheng@intel.com>)
---------------

  Prerequisites: GNU Emacs for Windows NT or Windows 95 from
    <http://www.gnu.org/software/emacs/windows/ntemacs.html>

  (The steps below might not be needed anymore in newer versions.)

  1. Expand files into directory (e.g. c:\VhdlMode)

  2. a) Windows NT:
	1. double click "System" icon from control panel
        2. select "Environment" tab
        3. at Variable line, add  HOME
           at Value line, add     c:\
           (note: assuming that you put the .emacs/_emacs file in c:\)
        4. click OK

     b) Windows 95:
	1. add the following line to autoexec.dat:

SET HOME=c:\

  3. Edit/create .emacs or _emacs file under c:\ (or whichever HOME is 
     pointing to) and add the following lines:
     (note: use '/' instead of '\' in the VhdlMode directory)

(setq load-path (cons (expand-file-name "c:/VhdlMode") load-path))
;;;
;;; VHDL mode
;;;
(autoload 'vhdl-mode "vhdl-mode" "VHDL Mode" t)
(setq auto-mode-alist (cons '("\\.vhdl?\\'" . vhdl-mode) auto-mode-alist))

  4. To associate ".vhd" to runemacs.exe:
     1. from Window Explorer select Options from the View pull-down menu
     2. select File Types tab
     3. click New Type
     4. enter description, "vhd" extension, and click New button
     5. at Action entry: run
        use browse to select the runemacs.exe from emacs bin dir,
        click OK
     After a system restart you should be able to run Emacs by double 
     clicking ".vhd" source from Explorer.

  5. Install required patches (see Patches section).


XEmacs
------

Packages used:
  - xemacs-base		mandatory
  - xemacs-devel	mandatory
  - c-support		mandatory
  - edit-utils		mandatory
  - mail-lib		mandatory
  - os-utils		mandatory
  - text-modes		mandatory
  - speedbar		optional	required by `speedbar'
  - ps-print-nomule	optional	required for postscript printing
  - fsf-compat		optional	`overlay' required by `hideshow'

Patches required:
  - itimer.el		mandatory for XEmacs 21.1.8 and lower
  (Install the included patches by putting the .el and .elc files in the same
  directory as vhdl-mode.el.)

Recompilation:
  - In case of errors during startup, try byte-compiling the source file
    with your XEmacs version:

      xemacs -batch -q -no-site-file -f batch-byte-compile vhdl-mode.el

Build (using gcc under SPARC):
  See first problem in the XEmacs' PROBLEMS file (affects function
  `skip-syntax-backward' that is used in VHDL Mode).
