[TASK] Code cleanup and some small documentation.

2010-11-28 16:51:43 +00:00
parent a20a91bf12
commit db9dda856c
7 changed files with 24 additions and 9 deletions
@@ -0,0 +1,17 @@
+# General
+This multiserver-ircbot is based on an advanced socket-driven framework.
+It's still in beta, but the basics are working.
+
+
+# Running the bot
+To run it, simply type ./start.sh into your console.
+
+
+# Documentation
+The documentation is not in the svn, but you can easily create it using the existing Doxyfile with doxygen.
+Simply run ./update-docs.sh and - if doxygen + dot are installed - you'll have a perfectly fine documentation.
+The Code itself should also give you an idea of how this works :-)
+
+
+# License
+This project is a private one, i don't know what license i will use yet.