niansa/asbots
1
0
Fork 0
mirror of https://gitlab.com/niansa/asbots.git synced 2025-03-06 20:48:25 +01:00
Code Releases Activity

Added README

Browse source
This commit is contained in:
Nils 2021-06-21 12:44:56 +02:00
parent ee52874033
commit 5a5d880a1a
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md Normal file
View file

@ -0,0 +1,28 @@
# asbots
This project aims for a simple yet complete irc services implementation for TS6 IRC daemons. VERY WIP!!!
## Building
This project uses cmake:
git clone https://gitlab.com/niansa/asbots.git
cd asbots
mkdir build
cd build
cmake ..
make -j$(nproc)
## Dependencies
The only direct dependency is [libasync-uv](https://gitlab.com/niansa/libasync-uv). See its README for installation instructions.
## Supported platforms
This should in theory work on almost all platforms, however I can't offer support for Windows since I can't test the software there.
Feel free to offer some help in getting this to work on Windows.
## Config file
The config file uses the "INIL" (INI-like) format, parsed by `configParser.cpp`. It's syntax is:
[section name]
key: value
end
An example is provided as `config.inil`