uIRC/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)
```sh
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**:
```sh
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/>.