diff --git a/README.md b/README.md new file mode 100644 index 0000000..c11ff58 --- /dev/null +++ b/README.md @@ -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` \ No newline at end of file