--
-- README
--
-- Copyright (C) 2005, 2006, 2011 Stefan Jahn <stefan@lkcc.org>
--
-- This is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2, or (at your option)
-- any later version.
--
-- This software is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this package; see the file COPYING.  If not, write to
-- the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
-- Boston, MA 02110-1301, USA.
--


Description
===========

The Qucs documentation consists of a technical description of the
simulation backend and several standalone tutorials as well as a work
book.

Requirements
============

Currently there are no dependencies on other software projects.

Installation
============

Unpack the distribution tarball:

    $ tar xvzf qucs-<version>.tar.gz               (using GNU tar)
    $ gzip -cd qucs-<version>.tar.gz | tar xvf -   (using another tar)

Change into the source directory:

    $ cd qucs-<version>
    $ cd qucs-doc

Configure the source package for your system:

    $ ./configure

Now compile the package:

    $ make

Install all generated PDF documents:

    $ make install

You must have root privileges if you want to install the package in the
standard location (/usr/local) or in any location that is only writable
by root.

For further information on installing the package, please consult the
file INSTALL included in this distribution.

Please note:  Users of the FreeBSD OS may use a GNU make (probably gmake)
to compile and install the package.

Getting the latest development snapshot
=======================================

You can always get the latest documentation version from our git
repository.

    $ git clone http://git.code.sf.net/p/qucs/git qucs

The documetation can be found in qucs/qucs-doc

Package maintainance
====================

Some checks are missing in configure.ac.
please implement them. here's a list.

  + Autoconf version 2.57 (at least)
  + GNU automake 1.7.0 (at least)
  + a LaTeX installation including
	* IEEEtran bibstyle
	* savesym
	* hyperref
  + GNU Octave (using version 2.0.17 here)
  + epsTk 2.0.1 (at least)
  + doxygen 1.4.5
  + dot 2.21 (graphviz 1.7)
  + transfig (fig2dev)