--
-- README
--
-- Copyright (C) 2003, 2005, 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
===========

Qucs is a circuit simulator with graphical user interface.  The
software aims to support all kinds of circuit simulation types,
e.g. DC, AC, S-parameter and harmonic balance analysis.  For
details see homepage:

http://qucs.sourceforge.net


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

Qucs needs Qt version 5 or later. For simplicity, the Qt configuration is
currently obtained through pkg-config, which you need to install in addition
to Qt.

Qt packages have strange names. Try these for Qt5/6 respectively

# apt install qtbase5-dev qttools5-dev libqt5svg5-dev
# apt-install qt6-base-dev qt6-svg-dev

Development
===========

Qucs source code is stored in a git repo. Two build systems are included.
The traditional autotools build system needs to be created by developpers,
when not using a tarball. Run ./bootstrap after cloning. The CMake build
system does not require this step. Choose your pick.

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>

Configure the source package for your system,

    $ ./configure

Configure the source package, but use Qt6

    $ ./configure --with-qt-name=Qt6

Now compile the package:

    $ make

Qt6 wants a newer standard, use the following.

    $ make CXXFLAGS=-std=c++17

Install Qucs:

    $ 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 Git snapshot
===============================

You can always get the latest Qucs version from our Git repository.
Please use an official release if you want to work with Qucs.  The Git
version might not even compile.

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

Press 'Enter' when asked for a password.  Run `sh bootstrap' and `configure'
(see above) with the appropriate options.  Maintainance currently requires
Autoconf version 2.57 and GNU automake 1.7.0.