2020-07-05 11:10:50 +00:00
|
|
|
# MicroIRC, a simple, lightweight IRC protocol helper
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
- CMake (tested on 3.17)
|
|
|
|
|
- Standard UNIX library
|
|
|
|
|
- C99+ compiler
|
|
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
First, create the required build files (usually the Makefile)
|
|
|
|
|
```sh
|
2020-07-11 21:52:50 +00:00
|
|
|
cmake . -DUSE_HELPERS=1 -DCMAKE_BUILD_TYPE=Release -DUIRC_IRCV3=1
|
2020-07-05 11:10:50 +00:00
|
|
|
```
|
2020-07-11 21:52:50 +00:00
|
|
|
Note: You can omit USE_HELPERS or/and UIRC_IRCV3 if you do not plan to use those features.
|
2020-07-05 11:10:50 +00:00
|
|
|
|
|
|
|
|
Following that, just use your build system and compile it
|
|
|
|
|
|
|
|
|
|
Example for **make**:
|
|
|
|
|
```sh
|
|
|
|
|
make
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You now should have the library built at `build/lib/libuirc.so`
|
|
|
|
|
|
|
|
|
|
## 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/>.
|
