From 2929380e12a21f265a50d10a8f78d17896c06262 Mon Sep 17 00:00:00 2001 From: Ben Kurtovic Date: Sun, 25 Mar 2012 00:18:41 -0400 Subject: [PATCH] Preliminary documentation updates --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3ecc02b..da0cf1f 100644 --- a/README.md +++ b/README.md @@ -22,18 +22,17 @@ integration between bot parts, and easier maintenance. # Installation -## Dependencies - -EarwigBot uses the MySQL library -[oursql](http://packages.python.org/oursql/) (>= 0.9.2) for communicating with -MediaWiki databases, and some tasks use their own tables for storage. -Additionally, the afc_history task uses -[matplotlib](http://matplotlib.sourceforge.net/) and -[numpy](http://numpy.scipy.org/) for graphing AfC statistics. Neither of these -modules are required for the main bot itself. - -`earwigbot.wiki.copyright` requires access to a search engine for detecting -copyright violations. Currently, -[Yahoo! BOSS](http://developer.yahoo.com/search/boss/) is the only engine -supported, and this requires -[oauth2](https://github.com/simplegeo/python-oauth2). +## From stable + +## From development + +# Setup + +It's recommended to run the bot's unit tests before installing. Run +`python -m unittest discover tests` from the project's root directory. + +*Note:* some unit tests require an internet connection. + +# Customizing + +# Hacking