From 1e54da29f3de6a12eb36205603bf64c113b5efcd Mon Sep 17 00:00:00 2001 From: Aaron Blakely Date: Tue, 7 Apr 2015 11:44:37 -0500 Subject: [PATCH] Updated README --- Makefile | 5 +++++ README.md | 20 ++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/Makefile b/Makefile index bdf71a5..019e36a 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,8 @@ OBJ=./build OBJECTS=$(OBJ)/*.o EXEC=xbot +.PHONY: mods + main: @rm -rf build @mkdir build @@ -17,5 +19,8 @@ main: $(CC) -o $(EXEC) $(OBJECTS) $(BINFLAGS) @echo "All Done!" +mods: + $(MAKE) -C mods/test + clean: @rm -rf build $(EXEC) \ No newline at end of file diff --git a/README.md b/README.md index c4782e4..96a7d17 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ # xbot + +Xbot is a modular C IRC bot. + + +## Building + +To build xbot use the following commands + + make + make mods + +Afterwords, just edit xbot.cfg and execute the xbot binary. + +## Built-in Admin Commands + +These are commands which allow the bot's admin to control it once it's connected to the IRC server. + +* LOADMOD +* JOIN +