aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 00844bd11b6ff5f58132f87e59a0778c32f35e3a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
* Probotic

Healthy for your coding ability, take once weekly, excessive doses
may result in arthritis, ass pain, and death.

Only for real chads, goto irc.rizon.net/#/g/chad for first-hand
enjoyment of the one and only probotic and to yell at the developers.

* Description

This bot will let you be delagated with challenges at dates within
it's database, this can all be done via the IRC interface.

See doc/api.md for detailed information about this interface.

* Building and Installation

First, you'll want specify your server and channel as well as bot username
and a password. This can be done either with command-line options or in a
specified credentials file. See docs/cli.txt for more information on that.

This'll require a few libraries:
libircclient-dev libsqlite3-dev build-essentials

You may then install the successful build, this'll naturally construct
a user, a database and a installation within this user's profile. You
may enact this by running ./install.sh under root, please view this
script and it's subscript ./bootstrap/boostrap.sh before running either.

* License

Copyright 2023 anon, fa11_1eaf, Emil

Probotic is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 only as
published by the Free Software Foundation.

Probotic 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 version 3 for more details.

You should have received a copy of the GNU General Public License
version 3 along with Probotic.