dbot/README.md

29 lines
903 B
Markdown
Raw Normal View History

2013-07-09 21:46:40 +02:00
# DBot IRC Bot
2012-03-10 20:40:02 +01:00
## Introduction
Depressionbot is an IRC bot which aims to be the fanciest IRC bot around - On
the general standard of software fanciness, dbot is statistically rated as being
'82% the same as bathing in fine, fine grape juice.'
2012-03-10 20:40:02 +01:00
2012-03-10 21:15:13 +01:00
Please note that this documentation is not complete and is a work in progress,
given I started it rather a long time after I began development of the project.
Please don't judge me too harshly for this as I am, in fact, mildly allergic to
writing documentation.
2012-03-10 21:14:47 +01:00
2012-03-10 20:40:02 +01:00
Requirements:
2012-03-10 21:10:49 +01:00
2012-03-10 21:04:03 +01:00
- Node JS
2012-07-17 15:13:30 +02:00
- [JSBot](http://github.com/reality/JSBot "JSBot"), a Javascript library which
2013-01-13 17:48:20 +01:00
handles the IRC protocol
- Underscore JS library
2012-03-10 21:04:03 +01:00
- Various modules have their own requirements also.
2012-03-10 20:40:02 +01:00
### External Modules
2012-07-17 15:13:30 +02:00
JSBot and externally developed modules can be imported by running the following
commands in the cloned repository:
2012-07-17 15:13:30 +02:00
git submodule init
git submodule update