{{>toc}}

h1. Dependencies

h2. Base environment

This project is managed with GNU Autotools (the magic behind "@./configure && make all install@"). It needs a unix-like shell command line which is native with all linux distributions, with MacOS, but not with Microsoft Windows.

For windows developpers, install either "MinGW":https://www.mingw-w64.org/ with "MSYS2":https://www.msys2.org/ or "Cygwin":https://cygwin.com/. I recommend the first one because Cygwin needs runtime dependencies which needs to be packaged with the builds. Whatever the choice, I will not document here how to install the installations processes, please read the related install docs.

I assume that MacOS developers already have "HomeBrew":https://brew.sh installed.

h2. Development repository

The project uses the Mercurial:https://www.mercurial-scm.org Version Control System and publish the "reporitory on the internet":https://hg.cerbelle.net/hg/rsstats. The first step is to download and install Mercurial.

h3. Debian based distributions (Ubuntu, Mint, ...)

<pre><code class="shell">
apt-get install -y mercurial
</code></pre>

h3. RedHat based distributions (Fedora, Rocky, Centos, RHEL, ...)

<pre><code class="shell">
yum install mercurial
</code></pre>

h3. MacOS

<pre><code class="shell">
brew install mercurial
</code></pre>

h3. Windows

A whole "Cygwin":https://cygwin.com/ or "MinGW":https://www.mingw-w64.org/ development environment is needed, thus I recommend to install a commandline mercurial client. And, given that Windows users prefer mouse over keyboard, "TortoiseHg":http://tortoisehg.org can be also installed to integrate Mercurial features in Windows file explorer.

h2. Compiler

h3. Compilation toolchain

h4. Debian

<pre><code class="shell">
apt-get install -y build-essential
</code></pre>


h4. RedHat

h4. MacOS

<pre><code class="shell">
xcode-select --install
</code></pre>

h4. Windows MinGW/MSYS2

h3. Autotools

Autotools generates files such as _configure_ which are distributed with the sources to compile them. This project does not store generated files in the repository. Thus, starting from the repository means to have autotools installed, to generate all the files needed to compile the project.

<pre><code class="shell">
apt-get install -y autoconf autogen libtool pkg-config
</code></pre>

<pre><code class="shell">
brew install autoconf autogen libtool pkg-config
</code></pre>

h3. Build libraries

h4. Debian

<pre><code class="shell">
apt-get install -y libssl-dev
</code></pre>

h4. RedHat

h4. MacOS

<pre><code class="shell">
brew install openssl@3
</code></pre>

h4. Windows

h2. Coding helpers (optional)

h3. CppCheck (code static analysis)

h3. AStyle (code formatting)

h1. Preparation

h2. Get sources

h2. Generate autotools files

h2. Library mandatory dependencies

For the developers, libopt was already installed with autogen and is available system-wide. For the maintainers, to avoid the need for autogen, a copy of libopts in automatically distributed in the source package.

The mandatory _libssl-dev_ and _libssl_ libraries should already be installed previously to allow @configure@ to be executed.

h2. Library optional dependencies

Optionaly, the _check_ library can be installed to allow unittesting.

h4. Debian

<pre><code class="shell">
apt-get install -y check
</code></pre>

h4. RedHat

h4. MacOS

<pre><code class="shell">
brew install check
</code></pre>

h4. Windows

h1. Code and test

From here, all the development specific dependencies are installed, but the project also have build dependencies (libraries).


h2. Configure

<pre><code class="shell">
./configure
</code></pre>


h2. Reformat the code

<pre><code class="shell">
make astyle
</code></pre>


h2. Analyze the code

<pre><code class="shell">
make cppcheck
xdg-open cppcheck/index.html
</code></pre>

<pre><code class="shell">
make cppcheck-clean
</code></pre>

h2. API and Source documentation

Included by default in @make all@ target

<pre><code class="shell">
make html
make pdf
</code></pre>

<pre><code class="shell">
make -C doc clean
</code></pre>

h2. Compilation and tests (unit and functional)

<pre><code class="shell">
make all check
</code></pre>

<pre><code class="shell">
make clean
</code></pre>


h2. Installation and check

<pre><code class="shell">
make DESTDIR=`pwd`/_inst install installcheck
</code></pre>
 
<pre><code class="shell">
make DESTDIR=`pwd`/_inst uninstall
</code></pre>

h1. Package

h2. Source distribution and check

<pre><code class="shell">
make dist distcheck
</code></pre>

<pre><code class="shell">
make distclean
</code></pre>


h2. Linux AppImage

<pre><code class="shell">
make linux-appimage
</code></pre>

<pre><code class="shell">
make linux-clean
</code></pre>


h2. Linux Debian/Ubuntu

<pre><code class="shell">
make debian-deb
</code></pre>

<pre><code class="shell">
make debian-clean
</code></pre>

h2. Linux RedHat/Fedora/CentOS/Rocky

apt-get install rpm
mkdir -p rpmbuild/{BUILD,RPMS,SOURCES,SPECS,SRPMS}


<pre><code class="shell">
make redhat-rpm
</code></pre>

<pre><code class="shell">
make redhat-clean
</code></pre>

h2. Windows ZIP/Installer

<pre><code class="shell">
make windows-zip
make windows-exe
</code></pre>

<pre><code class="shell">
make windows-clean
</code></pre>


h2. MacOS ZIP/DMG/PKG

<pre><code class="shell">
make macos-zip
make macos-dmg
make macos-pkg
</code></pre>

<pre><code class="shell">
make macos-clean
</code></pre>


h1. Wrapup