caskd
/
uIRC
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Activity
[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.
110 Commits 1 Branch 4 Tags 428 KiB
C 94.9%
CMake 5.1%
Go to file
Alex D. bb6be1d8ec
Bump version, fix inclustions and move tests outside of main repo 		2021-02-22 17:09:41 +00:00
include Bump version, fix inclustions and move tests outside of main repo 2021-02-22 17:09:41 +00:00
src Bump version, fix inclustions and move tests outside of main repo 2021-02-22 17:09:41 +00:00
.clang-format Reformat code, add if preprocessor comments, shorten structrs, remove analyzer 2020-12-16 14:22:25 +00:00
.clang-tidy uIRC version 0.1 -- beta 2021-02-15 11:39: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 Bump version, fix inclustions and move tests outside of main repo 2021-02-22 17:09:41 +00:00
COPYING Add GPL and .clang-format 2020-06-22 19:10:57 +02:00
README.md Few tweaks and some docs 2021-01-23 15:07:55 +00: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 -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 -
BUILD_DOCS Build documentation using doxygen (WIP) boolean false -
CODE_ANALYZER Use static analysis tools boolean false 2020.12.20
CODE_COVERAGE Generate code coverage output boolean false 2020.12.20

Following that, just use your build system and compile it

Example for make:

make -C build

You now should have the library built at build/libuirc.a or build/libuirc.so.VERSION

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/.