From 412c43036a13bcb3ba873518e74df7b7033daf75 Mon Sep 17 00:00:00 2001 From: niansa Date: Sat, 11 Feb 2023 17:42:20 +0000 Subject: [PATCH] Made the readme a bit nicer --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c11ff58..d318128 100644 --- a/README.md +++ b/README.md @@ -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` \ No newline at end of file +An example is provided as [`config.inil`](/config.inil)