Revised README and Build System
This commit is contained in:
parent
66da51c73f
commit
919aaac276
8
Makefile
8
Makefile
@ -23,13 +23,8 @@ ifdef SAN
|
|||||||
CFLAGS += -fsanitize=${SAN}
|
CFLAGS += -fsanitize=${SAN}
|
||||||
endif
|
endif
|
||||||
|
|
||||||
ifeq (${NO_VULN},1)
|
|
||||||
CPPFLAGS += -DNO_VULN_COMMANDS
|
|
||||||
endif
|
|
||||||
|
|
||||||
ifeq (${ENABLE_SSL},1)
|
ifeq (${ENABLE_SSL},1)
|
||||||
LDLIBS += -lssl -lcrypto
|
LDLIBS += -lssl -lcrypto
|
||||||
CPPFLAGS += -DIRC_SSL_SUPPORT
|
|
||||||
endif
|
endif
|
||||||
|
|
||||||
all: include/config.h ${PROGN}
|
all: include/config.h ${PROGN}
|
||||||
@ -40,9 +35,6 @@ ${PROGN}: ${HDR} ${SRC}
|
|||||||
# do nothing but update them...
|
# do nothing but update them...
|
||||||
${SRC} ${HDR}:
|
${SRC} ${HDR}:
|
||||||
|
|
||||||
submodules:
|
|
||||||
git submodule update --init --recursive
|
|
||||||
|
|
||||||
include/config.h: config.mk.h
|
include/config.h: config.mk.h
|
||||||
cp -f $< $@
|
cp -f $< $@
|
||||||
|
|
||||||
|
28
README.md
28
README.md
@ -3,30 +3,30 @@
|
|||||||
Healthy for your coding ability, take once weekly, excessive doses
|
Healthy for your coding ability, take once weekly, excessive doses
|
||||||
may result in arthritis, ass pain, and death.
|
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
|
* Description
|
||||||
|
|
||||||
This bot will let you be delagated with challenges at dates within
|
Prints useful challenges when requested.
|
||||||
it's database, this can all be done via the IRC interface.
|
|
||||||
|
|
||||||
See doc/api.md for detailed information about this interface.
|
See doc/api.md for detailed information about this interface.
|
||||||
|
|
||||||
* Building and Installation
|
* Building and Installation
|
||||||
|
|
||||||
First, you'll want specify your server and channel as well as bot username
|
Building requires (debian derived):
|
||||||
and a password. This can be done either with command-line options or in a
|
libsqlite3-dev build-essentials
|
||||||
specified credentials file.
|
|
||||||
|
|
||||||
You can simply run install.sh to build and install this project. See the
|
** Submodules
|
||||||
Makefile for specific build options, I highly recommend NVULN=1 for all
|
git submodule update --init --recursive
|
||||||
non-developmental deployments.
|
make -C lib/libircclient
|
||||||
|
|
||||||
This'll require a few libraries:
|
** Configuration (Optional but highly recommended)
|
||||||
libircclient-dev libsqlite3-dev build-essentials
|
make include/config.h && $EDITOR include/config.h
|
||||||
|
|
||||||
* Hosting
|
** Building and Installation
|
||||||
|
make && BOOTSTRAP_ONLY=1 ./install.sh
|
||||||
|
|
||||||
|
remove BOOTSTRAP_ONLY=1 if you plan to install this somewhere.
|
||||||
|
|
||||||
|
* Source Code Hosts
|
||||||
|
|
||||||
https://git.lain.church/emil/probotic
|
https://git.lain.church/emil/probotic
|
||||||
https://bis64wqhh3louusbd45iyj76kmn4rzw5ysawyan5bkxwyzihj67c5lid.onion/emil/probotic
|
https://bis64wqhh3louusbd45iyj76kmn4rzw5ysawyan5bkxwyzihj67c5lid.onion/emil/probotic
|
||||||
|
@ -1 +1,7 @@
|
|||||||
#define DBFILE "probotic_data.sqlite"
|
#define DBFILE "probotic_data.sqlite"
|
||||||
|
|
||||||
|
/* Disables vulnerable commands */
|
||||||
|
/* #define NO_VULN_COMMANDS */
|
||||||
|
|
||||||
|
/* Enables SSL support */
|
||||||
|
/* #define IRC_SSL_SUPPORT */
|
||||||
|
7
install.sh
Normal file → Executable file
7
install.sh
Normal file → Executable file
@ -7,9 +7,10 @@ TARGET=${TARGET-/opt/probotic}
|
|||||||
DIR=$(dirname $(readlink -f "$0"))
|
DIR=$(dirname $(readlink -f "$0"))
|
||||||
cd $DIR
|
cd $DIR
|
||||||
|
|
||||||
# BUILD & BOOTSTRAP
|
# BOOTSTRAP
|
||||||
make -C $DIR DEBUG=0 NVULN=1 || exit 1
|
cd $DIR/bootstrap && ./bootstrap.sh || exit 1
|
||||||
$DIR/bootstrap/bootstrap.sh || exit 1
|
cd ..;
|
||||||
|
[ "$BOOTSTRAP_ONLY" = 1 ] && exit 0
|
||||||
|
|
||||||
# INSTALL
|
# INSTALL
|
||||||
mkdir -p $TARGET
|
mkdir -p $TARGET
|
||||||
|
0
uninstall.sh
Normal file → Executable file
0
uninstall.sh
Normal file → Executable file
Reference in New Issue
Block a user