Updated README
This commit is contained in:
parent
a718957b7f
commit
1e54da29f3
5
Makefile
5
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)
|
20
README.md
20
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 <module>
|
||||
* JOIN <channel>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user