Initial commitHEADmaster

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..00844bd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,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.