[UNDER HEAVY DEVELOPMENT] Simple and lightweight IRC protocol helper
This repository has been archived on 2021-04-17. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Alex D. 0d019b02dc
Reformat code, add if preprocessor comments, shorten structrs, remove analyzer
2020-12-16 14:22:25 +00:00
include Reformat code, add if preprocessor comments, shorten structrs, remove analyzer 2020-12-16 14:22:25 +00:00
src Reformat code, add if preprocessor comments, shorten structrs, remove analyzer 2020-12-16 14:22:25 +00:00
tests Fix useless test 2020-11-03 22:34:51 +01:00
.clang-format Reformat code, add if preprocessor comments, shorten structrs, remove analyzer 2020-12-16 14:22:25 +00:00
.clang-tidy Reformat code, add if preprocessor comments, shorten structrs, remove analyzer 2020-12-16 14:22:25 +00:00
.gitignore Fix reseved identifiers, fix problems about signedness and casting and add a few more test cases 2020-09-26 23:22:05 +02:00
CMakeLists.txt Reformat code, add if preprocessor comments, shorten structrs, remove analyzer 2020-12-16 14:22:25 +00:00
COPYING Add GPL and .clang-format 2020-06-22 19:10:57 +02:00
README.md Add new options and tweak stuff around 2020-10-29 21:33:37 +01:00

README.md

MicroIRC, a simple, lightweight IRC protocol helper

Requirements

  • CMake (tested on 3.17)
  • C99+ compiler

Building

First, create the required build files (usually the Makefile)

cmake -H . -B build/ -DCMAKE_BUILD_TYPE=Release
Option Description Type Default Supported since
BUILD_HELPERS Build simple assemblers and tokenizers that handle the heavy lifting boolean true -
BUILD_VALIDATORS Build validators that check if the messages follow the standards (WIP) boolean true 2020.10.29
BUILD_TESTS Build tests that check if the build results behave as they should boolean false -
BUILD_IRCV3 Build IRCv3 support (WIP) boolean true -

Following that, just use your build system and compile it

Example for make:

cd build/
make

You now should have the library built at build/libuirc.so (or your build output path)

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.