SZARP installation guide
========================

Authors:
Paweł Pałucha <pawel@praterm.com.pl>
Tomasz Pieczerak <tph@newterm.pl>
Aleksy Barcz <abarcz@newterm.pl>

This file briefly describes how to install SZARP software. The simplest way of
installation for end-users it to use Debian packages.

SZARP is compiled and run on Debian GNU/Linux (i386, amd64, armel/armhf)
and Ubuntu. On Windows you can use WSL (Windows Subsystem for Linux).
All the development and testing is done only on Debian GNU/Linux,
so you can run into some problems with other distributions.

1. Installation from source.

NOTE:
This method of installation is not recommended - you will need to manually setup
some configuration files, crontab entries and so on. This method is not used
by us or any SZARP user we know. If you want to play with source code, we
recommend to install Debian packages so all the stuff will be in correct place.
Then you can replace binaries with your own compiled versions or run them
directly from your working directory.

SZARP uses cmake for build and deployment (some files may still be deployed with
with configure scripts), so you need cmake to start with.
The commands to build SZARP are:

# cmake .

This invokes cmake and runs checks for missing libraries. All libraries
should be present for SZARP to build and run properly.

# make

This should compile everything, including documentation. If there are errors,
you have found a bug. Patches are welcome if they don't break Debian builds.
For building SZARP you will need at least 4GB RAM, as parts of the code use
templates extensively, more is recommended.

Now you can become root and type:

# make install

Default install directory is /opt/szarp.

To clean everything use:

# make clean

To get rid of files and dirs generated by cmake, use:

# ./maintainer-clean.sh


2. Installation of Debian packages.

This is the simplest and best supported method of installation.
Add following line to /etc/apt/sources.list:

deb http://packages.szarp.org/debian stretch main

Then run:

# apt-get update

and one of the following:

# apt-get install szarp-server
# apt-get install szarp-terminal