Zealot

README
Login

README

Zealot is a Dash-compatible documentation server.

Installation

The code implementing Zealot is written in C++.

If you unpacked a binary distribution archive of Zealot, you should be able to run the program zealot (for unixoid systems) or zealot.exe (for windows-like systems) directly. You can verify the authenticity of the distribution archives using Minisign:

minisign -Vm zealot-... -P RWQqcIdQLuG/Iiw3rcwD9D3Wu8UojK49fBSLibuda44tqkEcZV+xTfYC

Alternatively, you can run Zealot using Docker. Images are provided in the repository chust/zealot. Where you would run zealot, you can instead type docker run --rm chust/zealot.

If you want to compile Zealot from source, you will need a C++14 compiler, the CMake build tool, and the Conan package manager. The program depends on Poco.

Starting the Server

In the most basic scenario, the zealot executable serves the docsets found in its working directory:

cd /data/dash
zealot