Copyright (C) 2019-2020 Michal Babik

This program 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 3 of the License, or
(at your option) any later version.

This program 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 program.  If not, see <https://www.gnu.org/licenses/>.


Basic Installation
-------------------

A most simple way to install application is to unpack archive,
go to sources directory and type:

    ./configure
    make
    make install

Although I suggest to configure and compile with more detailed options
described below.


Compilers and Options
----------------------

For a normal daily use of this program a good option should be:

    ./configure CC="gcc" CFLAGS="-march=native -O2 -pipe -std=gnu11"

Or with Clang

    ./configure CC="clang" CFLAGS="-march=native -O2 -pipe -std=gnu11"

It disables the standard -g option which produces debugging information
needed for gdb and enlarges the output file,

CC="gcc"       sets the C compiler to GCC,
CC="clang"     sets the C compiler to Clang,

-march=native  enables all instruction subsets supported by the local machine,
-O2            sets the code optimization to O2.
-pipe          use pipes rather than temporary files for communication between
               the various stages of compilation,
-std=gnu11     sets the C standard to C11 with GNU extensions.

Executing:

    ./configure --help

will print detailed description of available initial values for
configuration parameters.

