########################################################
##  GAL/PAL chip emulator                             ##
##  Copyright (C) 2008 Michael Buesch <mb@bu3sch.de>  ##
##  Licensed under the GNU/GPL version 2 or later     ##
########################################################


This is an emulator for Generic Array Logic chips.
It takes the fuse-map as a JEDEC file and can emulate the chip package
output pin states, based on variable input pin states.


Supported devices
=================

* GAL22V10


Commandline or GUI
===================

There are two tools available.
galemu.py for the commandline execution and
galemugui.py with a crappy QT based GUI

The commandline tool "galemu.py" takes the JEDEC file and the input pin
states as commandline args. After execution of the emulation, it prints the
output pin states to stdout. So the commandline tool is not that useful for
chips using registered OLMCs.

In the GUI tool "galemugui.py" everything is loaded and configured
dynamically. So you can also properly emulate registered-OLMC stuff there.


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

- You need python-2.5 or later to execute the tools.
- The GUI tool "galemugui.py" depends on PyQT4.
  On Debian Linux it's provided by the "python-qt4" package.


Installing
==========

The emulator is a Python program. Installation is not needed and you can
execute it directly from the source code tree, which is recommended.
But if you want to install it anyway, simply execute:
$ sudo python ./setup.py install


Testsuite
=========

To run a selftest, just execute the "testsuite.py" script:
$ python ./testsuite.py
It will run through a number of self-tests, defined in the testsuite
subdirectory, and print the results to stdout.


How to write new selftests?
===========================

See the file "000-README" in the "testsuite" subdirectory.