Create README.md

solson · Mar 26, 2013 · 2eae080 · 2eae080
1 parent 11336e4
commit 2eae080
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+enfin
+=====
+A simple IRC bot in C.
+
+Building
+--------
+Just `make`.
+
+Running
+-------
+``` sh
+$ ./enfin irc.freenode.net 6667
+```
+
+It will join the channel #bots.
+
+Dependencies
+------------
+Enfin uses the [talloc](http://talloc.samba.org) library. It's probably in your Linux distribution's repositories.