========================================================================
                              README
========================================================================

ABOUT:
This program is the backend status daemon for api.voxelands.com

DEPENDENCIES:
vl-checker requires glibc, and mysql. It may work with
 other C libraries, but this has not been tested.

INSTALL:
If you're reading this then you've already unpacked the tarball,
so it's the usual 3 steps:
1) cd /path/to/voxelands-api
2) make
3) su -c "make install"

UNINSTALL:
just cd to the voxelands-api directory and run "make uninstall"

USE:
vl-checker [OPTION]

OPTIONS:
 -d Daemonise the process (default).
 -D Do not daemonise the process.
 -a Check all servers on startup (default).
 -A Do not check all servers on startup.
 -o Run check only once.
 -O Run check repeatedly in a loop (default).
 -? Show this help info.

CONFIG:
what config?

LICENSE:
All of voxelands is licensed under the GPLv3, there's a copy of it in
  LICENSE

DEVELOPMENT:
A git repository for this code is hosted at:
 https://gitlab.com/voxelands/voxelands-api
An IRC channel for development of this and other parts of voxelands is
 at irc.entropynet.net #voxelands

CHANGES:
see CHANGELOG