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.
uIRC/README.md

47 lines
2.2 KiB
Markdown
Raw Normal View History

2020-07-05 11:10:50 +00:00
# MicroIRC, a simple, lightweight IRC protocol helper
## Requirements
- CMake (tested on 3.17)
2020-12-30 19:14:21 +00:00
- C99 compiler
2020-07-05 11:10:50 +00:00
## Building
First, create the required build files (usually the Makefile)
```sh
2020-12-30 19:14:21 +00:00
cmake -B build/ -DCMAKE_BUILD_TYPE=Release .
2020-07-05 11:10:50 +00:00
```
2020-10-29 20:33:37 +00:00
| 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 | - |
2021-01-03 23:45:29 +00:00
| BUILD_DOCS | Build documentation using doxygen (WIP) | boolean | false | - |
2021-01-03 01:04:14 +00:00
| CODE_ANALYZER | Use static analysis tools | boolean | false | 2020.12.20 |
2020-12-30 19:14:21 +00:00
| CODE_COVERAGE | Generate code coverage output | boolean | false | 2020.12.20 |
2020-07-05 11:10:50 +00:00
Following that, just use your build system and compile it
Example for **make**:
```sh
2020-12-30 19:14:21 +00:00
make -C build
2020-07-05 11:10:50 +00:00
```
You now should have the library built at `build/libuirc.a` or `build/libuirc.so.VERSION`
2020-07-05 11:10:50 +00:00
## 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/>.