INSTALL.md

Go to the documentation of this file.

# Installation{#install}
\tableofcontents

Here you may find the instructions to install the library on your environment.

# Linux
The library is distributed as *libCAENMCA.so*.

## Requirements
Supported architectures:
* x86
* x86-64
* armhf (gnueabihf)

Compiler:
* **gcc** or **clang** (any version supporting C99)

Additional libraries required:
* **libxml2** (version >= 2.6)
* **libgssdp-1.0** (version >= 0.2)

To install the dependencies on the main Linux distributions:

**Debian/Ubuntu** and derivatives:
``` bash
$ sudo apt install gcc make pkg-config
$ sudo apt install libxml2-dev libgssdp-1.0-dev
```

**RHEL/CentOS/Fedora/SL** and derivatives:
``` bash
$ sudo yum install gcc make pkgconf-pkg-config
$ sudo yum install libxml2-devel gssdp-devel
```

**Arch/Manjaro** and derivatives:
``` bash
$ sudo pacman -S gcc make pkgconf
$ sudo pacman -S libxml2 gssdp
```
## Install
When all the dependencies are satisfied, extract the source code from the compressed archive,
enter the source folder (`libcaenmca-X.Y.Z`), and there compile the library executing the
usual commands:

``` bash
$ tar xfvz libcaenmca-X.Y.Z.tar.gz
$ cd libcaenmca-X.Y.Z
$ ./configure [--prefix=<installdir>]
$ make
$ sudo make install
```

\note If not set, the default `<installdir>` is set to `/usr`.

This will install both library and headers in the system folders.

# Windows
The library is distributed as *CAENMCA.dll* (and the import library *CAENMCA.lib*).

## Requirements
Supported architectures:
* x86
* x64

Minimum platform toolset: **Visual Studio 2015** (14.0).

The library requires **libxml2**, that is included in the installer. No additional library is required.

## Install
Just use the installer provided.

\note The default install directory is set to `C:\Program Files\CAEN\Digitizers\CAENMCA`.