ReadMe
1 ReadMe
2 --------
3Start Date : 2004-04-03
4Last Update : 2015-04-03
5Author : Mike Waters
6Email : mwaters517_AT_gmail_DOT_com
7====================================================================================================
8
9 Table of Contents
10
11 1. Introduction.
12 2. Installation.
13 3. Documentation.
14 4. Examples.
15 5. Bugs / Things To Do.
16
17----------------------------------------------------------------------------------------------------
18
191. Introduction.
20
21
22GNU Spice GUI is intended to provide a GUI to freely available electronic circuit simulation engine
23eg. GNU-Cap, NG-Spice. It uses gnetlist to convert schematic files to net list files and gwave to
24display simulation results. gschem is used as the schematic capture tool.
25
26The version numbering scheme uses the format : vA.B.CD
27 A is the major release number (rarely updated).
28 B is the minor release number (infrequently updated).
29 CD is the modification number (incremented as a result of almost any change).
30
31For example version 1.0 would be designated v1.0.00, any version with a major release number of 0 is
32pre-version 1.0. Until version 1.0.00 is released the version number will represent a percentage of
33the development completed towards version 1.0.00. Eg. v0.5.60 would signify that roughly %56 of the
34development effort has been completed towards version 1.0.00.
35
36----------------------------------------------------------------------------------------------------
37
382. Installation.
39
40
41Refer to the Install file.
42
43----------------------------------------------------------------------------------------------------
44
453. Documentation.
46
47
48Refer to the HTML User Manual in <install-dir>/html/User-Manual.html or while running gSpiceUI refer
49to the in application documentation (which are the same).
50
51----------------------------------------------------------------------------------------------------
52
534. Examples.
54
55
56The directory <install-dir>/sch contains various schematic files which may be used to experiment
57with gSpiceUI. These examples show how to prepare a schematic for simulation, which is not always a
58trivial task. It should be noted however that not all schematics are guaranteed to work.
59
60The directory <install-dir>/sch/demos contains various small example schematic files which are
61intended to illustrate the simulation of specific circuit elements eg. a diode. The intention is
62that these schematics should all work when simulated using gSpiceUI.
63
64The remaining schematics files in <install-dir>/sch are not guaranteed to behave properly when
65simulated. These files are a collection of things that have taken my interest over the years, some
66work and some don't.
67
68----------------------------------------------------------------------------------------------------
69
705. Bugs / Things To Do.
71
72
73Refer to the ToDo file for a list of known bugs and features which could be added in the future. If
74you have the sources the file <install-dir>/src/Version.hpp contains a list of bugs which need
75addressing in the short term.
76
77====================================================================================================
78