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

Made the readme a bit nicer

Browse source
This commit is contained in:
niansa 2023-02-11 17:42:20 +00:00
parent 58753858b4
commit 412c43036a
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,8 +1,8 @@
# asbots
This project aims for a simple yet complete irc services implementation for TS6 IRC daemons. VERY WIP!!!
This project aims for a simple yet complete irc services implementation for TS6 IRC daemons. Not completed, but feel free to pick it up as a base for your own project!
## Building
This project uses cmake:
This project uses CMake:
git clone https://gitlab.com/niansa/asbots.git
cd asbots
@ -12,17 +12,17 @@ This project uses cmake:
make -j$(nproc)
## Dependencies
The only direct dependency is [libasync-uv](https://gitlab.com/niansa/libasync-uv). See its README for installation instructions.
The only direct library dependency is [libasync-uv](https://gitlab.com/niansa/libasync-uv). A C++20 compliant compiler is required. 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:
The config file uses the "INIL" (INI-like) format, parsed by [`configParser.cpp`](/configParser.cpp). It's syntax is:
[section name]
key: value
end
An example is provided as `config.inil`
An example is provided as [`config.inil`](/config.inil)