                                    ReadMe
                                   --------
Start Date  : 03/04/2004
Last Update : 29/09/2009

-------------------------------------------------------------------------------

gSpiceUI - A Graphical User Interface (GUI) to various freely available
           electronic circuit simulation engines.

Author : Mike Waters
Email  : M.Waters@bom.gov.au

-------------------------------------------------------------------------------

                               Table of Contents

  1.  Introduction.
  2.  Installation.
  3.  Documentation.
  4.  Examples.
  5.  Bugs / Things To Do.

-------------------------------------------------------------------------------

1.  Introduction.


GNU Spice GUI is intended to provide a GUI to freely available electronic
circuit simulation engine eg. GNU-Cap, NG-Spice. It uses gnetlist to convert
schematic files to net list files and gwave to display simulation results.
gschem is used as the schematic capture tool.

The version numbering scheme uses the format : vA.B.CD
  A  is the major release number (rarely updated).
  B  is the minor release number (infrequently updated).
  CD is the modification number (incremented as a result of almost any change).

For example version 1.0 would be designated v1.0.00, any version with a major
release number of 0 is pre-version 1.0. Until version 1.0.00 is released the
version number will represent a percentage of the development completed towards
version 1.0.00. Eg. v0.5.60 would signify that roughly %56 of the development
effort has been completed towards version 1.0.00.

-------------------------------------------------------------------------------

2.  Installation.


Refer to the Install file.

-------------------------------------------------------------------------------

3.  Documentation.


Refer to the HTML User Manual in <install-dir>/html/User-Manual.html or, while
running gSpiceUI refer to the on-line documentation (which are the same).

-------------------------------------------------------------------------------

4.  Examples.


The directory <install-dir>/sch contains various example schematic files which
may be used to experiment with gSpiceUI. These examples also show how to
prepare a schematic for simulation, which is not always a trivial task.

NOTE : There's no guarantee that all of the example schematic files will behave
       properly when simulated. These files are a collection of things that
       have taken my interest over the years, some work some don't.

-------------------------------------------------------------------------------

5.  Bugs / Things To Do.


Refer to the ToDo file for a list of features which could be added in the
future. If you have the sources the file <install-dir>/src/Version.hpp contains
a list of bugs which need addressing.

-------------------------------------------------------------------------------
