Create README.md

This commit is contained in:
mrkubax10 2023-09-05 11:34:45 +02:00
parent 1bafc1a69e
commit b9cb3a39ec

9
README.md Normal file
View File

@ -0,0 +1,9 @@
# irclogger_web
irclogger_web is a highly configurable IRC logger with web frontend. It's written in Perl.
## Installation
1. You need to have Perl and SQLite3 interpreter installed.
2. Following Perl packages have to be installed: [DBI](https://metacpan.org/pod/DBI), [DBD::SQLite](https://metacpan.org/pod/DBD::SQLite).
3. Run `./prepare_database.sh` to create SQLite3 database for storing users, servers and logged channels.
4. See `configuration.pm` and adjust it to your needs.
5. Run `perl main.pl` to start HTTP server and logger.