ngspice-26: update documentation

This commit is contained in:
h_vogt
2014-01-11 16:24:37 +01:00
committed by rlar
parent b19641dcc2
commit 8c99ec76f4
10 changed files with 168 additions and 121 deletions
+20 -18
View File
@@ -5,7 +5,7 @@ Table of contents
1 Ngspice installation (LINUX)
1.1 Prerequisites
1.2 Install from tarball (e.g. ngspice-25.tar.gz)
1.2 Install from tarball (e.g. ngspice-26.tar.gz)
1.3 Install from git repository
1.4 Advanced Install
1.4.1 Most useful options
@@ -41,7 +41,7 @@ This file describes the procedures to install ngspice from sources.
bison, flex, and X11 headers and libs.
If you want to compile the source from the git repository you need
additional software: autoconf, automake, libtool, texinfo.
additional software: autoconf, automake, libtool, texinfo, readline.
The following software may be needed when enabling additional features:
editline, tcl/tk, adms
@@ -51,14 +51,14 @@ This file describes the procedures to install ngspice from sources.
information on ngspice and its usage.
1.2 Install from tarball (e.g. ngspice-25.tar.gz)
1.2 Install from tarball (e.g. ngspice-26.tar.gz)
This covers installation from a release distribution (for example
ngspice-25.tar.gz, the so called tar ball).
ngspice-26.tar.gz, the so called tar ball).
After downloading the tar ball to a local directory unpack it using:
$ tar -zxvf ngspice-25.tar.gz
$ tar -zxvf ngspice-26.tar.gz
Now change directories in to the top-level source directory (where this
INSTALL file can be found).
@@ -99,12 +99,12 @@ This file describes the procedures to install ngspice from sources.
This section describes how to install from source code taken directly
from the git repository. It is intended for those who want to use the most
recent enahancements of ngspice and for developers. For user install
recent enhancements of ngspice and for developers. For user install
instructions using source from a released distributions, please see the
sections titled 'Install from tarball' and 'Advanced Install'.
Download ngspice sources from the git repository as described on the sourceforge project page
(see http://sourceforge.net/projects/ngspice/ and click on the git link)
(see http://ngspice.sourceforge.net/download.html and click on the git link)
Now change directories in to the top-level source directory (where this
INSTALL file can be found).
@@ -115,7 +115,7 @@ This file describes the procedures to install ngspice from sources.
$ ./autogen.sh
$ mkdir debug
$ cd debug
$ ../configure --enable-maintainer-mode
$ ../configure --with-x --with-readline=yes
$ make
$ sudo make install
@@ -123,7 +123,7 @@ This file describes the procedures to install ngspice from sources.
that can be passed to ./configure to customise the build and installation.
Preferred arguments to ./configure to obtain a comfortably working ngspice may be
--with-readline=yes and --disable-debug (for smaller and speed optimized
--with-readline=yes and --disable-debug (for a smaller and speed optimized
executable).
A fully featured ngspice on LINUX may be obtained with the following commands:
@@ -134,8 +134,8 @@ This file describes the procedures to install ngspice from sources.
$ make 2>&1 | tee make.log
$ sudo make install
If a problem is found with the build proccess, please submit a report to
the Ngspice development team. Please provide information about your system
If a problem is found with the build process, please submit a report to
the ngspice development team. Please provide information about your system
and any ./configure arguments you are using, together with any error
messages. Ideally you would have tried to fix the problem yourself first.
If you have fixed the problem then the development team will love to hear
@@ -451,8 +451,8 @@ Most of the options now following are not well maintained, are not tested or eve
to the standard install (FLEX and BISON have to be made available in MSYS).
Some links are given below which describe the procedures.
Installing from the tarball, e.g. ngspice-25.tar.gz, is now simple: After
expanding, you may just run ./compile_min.sh from the ngspice-25 directory.
Installing from the tarball, e.g. ngspice-26.tar.gz, is now simple: After
expanding, you may just run ./compile_min.sh from the ngspice-26 directory.
The default installation location of ngspice is the Windows path
C:\spice. The install path can be altered by passing --prefix=NEWPATH
@@ -466,14 +466,14 @@ Most of the options now following are not well maintained, are not tested or eve
The procedure of compiling a distribution (for example, a tarball from
the ngspice website), is as follows:
$ cd ngspice-25
$ cd ngspice-26
$ mkdir release
$ cd release
$ ../configure --with-wingui ...and other options
$ make
$ make install
The useful options are:
The most useful options are:
--enable-xspice
--enable-cider
--disable-debug (-O2 optimization, no debug information)
@@ -486,9 +486,10 @@ Most of the options now following are not well maintained, are not tested or eve
$ make install
However, to compile code extracted from the git repository the procedure is
a little different. To obtain ngspice, you may do the following:
a little different. Firstly install git, e.g. from http://git-scm.com/download/win
To obtain ngspice, you may do the following:
Go to a directory of your choice, e.g. D:\Spice
Open the git command window. Go to a directory of your choice, e.g. D:\Spice
$ cd /d/Spice
Issue the command for downloading ngspice:
@@ -562,7 +563,8 @@ Most of the options now following are not well maintained, are not tested or eve
vngspice.sln (project starter) and
vngspice.vcproj (project contents)
allows to compile and link ngspice with MS Visual Studio 2008.
The project is probably not compatible with Visual Studio 2005.
Newer Visual Studio versions will translate the project files
into their compatible format (tested with MS Visual Studio 2010).
/visualc/include contains a dedicated config.h file. It contains the
preprocessor definitions required to properly compile the code.