Flea/README.md

# Flea
Flea aims to be a modular Python IRC bot. This software was inspired from older
IRC bots I wrote.

## License
Flea is released under the
[GNU AGPLv3](https://www.gnu.org/licenses/why-affero-gpl.html), please **direct
your attention to the LICENSE file in the root of the repository** before
continuing.

## Requirements
Flea was written in [Python 2.7](http://www.python.org/download/releases/2.7/)

## Quick Start
1. Edit the *settings.conf* file to appropriate settings on the server you would
like to use

2. Run the terminal/console in the root of the project and type:
*python Flea.py*
Initial Commit Setup project structure; Added a basic configuration parser 2016-01-25 11:07:39 +00:00			`# Flea`
Added Control Plugin Added Control Plugin: authentication and basic control of IRC commands; Move settings and packet info into the IRC class; Minor fix of irclib's Whois function 2016-02-03 23:14:45 +00:00			`Flea aims to be a modular Python IRC bot. This software was inspired from older`
Initial Commit Setup project structure; Added a basic configuration parser 2016-01-25 11:07:39 +00:00			`IRC bots I wrote.`

			`## License`
Added Control Plugin Added Control Plugin: authentication and basic control of IRC commands; Move settings and packet info into the IRC class; Minor fix of irclib's Whois function 2016-02-03 23:14:45 +00:00			`Flea is released under the`
			`[GNU AGPLv3](https://www.gnu.org/licenses/why-affero-gpl.html), please **direct`
			`your attention to the LICENSE file in the root of the repository** before`
Initial Commit Setup project structure; Added a basic configuration parser 2016-01-25 11:07:39 +00:00			`continuing.`

			`## Requirements`
			`Flea was written in [Python 2.7](http://www.python.org/download/releases/2.7/)`

			`## Quick Start`
Connection stays open, added IRC library Connection stays open and bot will continuously ping back. Added improved IRC library from an old Python IRC bot I wrote, it is mostly changed except for the IRC parser; Changed default settings.conf port to 7001 because SSL/TLS connections are currently the only choice. 2016-01-28 13:20:37 +00:00			`1. Edit the settings.conf file to appropriate settings on the server you would`
			`like to use`
Added Control Plugin Added Control Plugin: authentication and basic control of IRC commands; Move settings and packet info into the IRC class; Minor fix of irclib's Whois function 2016-02-03 23:14:45 +00:00
			`2. Run the terminal/console in the root of the project and type:`
Initial Commit Setup project structure; Added a basic configuration parser 2016-01-25 11:07:39 +00:00			`python Flea.py`