ASKL version 0.3.9
==================

Askell - Savenn Kehentiñ Liesprotokol

Copyright (c) 2026 Raphael Prevost <[email protected]>

Description
===========

    ASKL is a server framework, providing all the necessary building blocks to
design and implement efficient TCP or UDP services.

    The scope of this framework is not limited to networking functionalities;
it also provides a database access API, a string library, and a module system
to host various services on top of ASKL.

    ASKL can be embedded by linking against libaskl and implementing a builtin
module, or extended using custom modules.

Requirements
============

    ASKL should compile and run on most POSIX-compliant operating systems
providing POSIX threads support and the GNU C Compiler.

    ASKL can also compile and run on Microsoft Windows 2000 and above.

Installation
============

    * POSIX-compliant Operating Systems
      ---------------------------------

    To compile ASKL and the shipped modules simply run the following command:

        make -j3

    If you need to rebuild it, please run the following command first:

        make clean

    Once the compilation is over, you can run the server in interactive mode
    with this command:

        LD_LIBRARY_PATH=. ./askl

    Or start it as a daemon:

        LD_LIBRARY_PATH=. ./askl -d

    Don't hesitate to see the different options available, using:

        LD_LIBRARY_PATH=. ./askl --help

    * Microsoft Windows 2000 and above
      --------------------------------

    To compile ASKL and the shipped modules, you will need to use the free
    Dev-C++ development environment available at this address:

        https://dev-cpp.com/Dev-Cpp-5/

    Once Dev-C++ is installed and working, just go to the folder win32/ and
    compile the libaskl.dev project, then the askl.dev project.

    The projects come with the required dynamic link libraries, which are
    freely redistributable.

    You can run ASKL in interactive mode with this command:

        askl.exe

    You can also install it as an NT Service using:

        askl.exe /i

    and uninstall it with:

        askl.exe /u

    Don't hesitate to see the different options available using:

        askl.exe /h

Thanks
======

    Thank you for using ASKL!