From 88ce331194155bddbdf9a59e9f97473b8e2597b2 Mon Sep 17 00:00:00 2001 From: Natanael Copa Date: Fri, 19 Jun 2015 11:49:48 +0200 Subject: readme: add info on how to build --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cebf749..75be8ca 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,41 @@ sircbot a small IRC bot for use with git hooks, cronjobs, scripts etc +Compile +------- + +To build sircbot you need a C compiler and GNU make. To build the lua +module you need Lua 5.1, 5.2 or 5.3. + +To compile sircbot run: + + make + + +You can set various compile options in config.mk: + + CFLAGS=-Os + LUA_VERSION=5.2 + + +Running the server +------------------ start the server with: - sircbot -s SERVER -n NICK '#channel1' '#channel2' + + sircbot -s SERVER -n NICK '#channel1' '#channel2' It connects to server and joins given channels. When a channel is joined it creates a unix socket /var/run/sircbot/<#channel> which can connected to with sircbot-send. + +Sending messages +---------------- + To send to a connected channel use: - echo "$message" | sircbot-send '#channel1' + echo "$message" | sircbot-send '#channel1' sircbot-send will send everything from stdin to given channel. -- cgit v1.2.3