From c83ce895c24b6cdf78d535739d754d3008de4d75 Mon Sep 17 00:00:00 2001
From: Ben Kurtovic <ben.kurtovic@gmail.com>
Date: Fri, 12 Sep 2014 23:41:56 -0500
Subject: [PATCH] More complete documentation on running the tool.

---
 README.md | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 70fef83..947abf3 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 This is a [copyright violation](https://en.wikipedia.org/wiki/WP:COPYVIO)
 detector running on [Wikimedia Labs](https://tools.wmflabs.org/copyvios).
 
-It works by searching the web for page content, or comparing an article to a
-specific URL.
+It can search the web for content similar to a given article, and graphically
+compare an article to a specific URL.
 
 Dependencies
 ============
@@ -21,7 +21,27 @@ Dependencies
 Running
 =======
 
-- Install all dependencies.
-- Copy `.lighttpd.conf` to the relevant location.
+- Install all dependencies listed above. You might want to use a
+  [virtualenv](http://virtualenv.readthedocs.org/).
+- Create the SQL database defined in `schema.sql`. Also create the `cache` and
+  `cache_data` tables defined by
+  [earwigbot-plugins](https://github.com/earwig/earwigbot-plugins/blob/develop/tasks/schema/afc_copyvios.sql);
+  this can be in the same or a different database.
+- Create an earwigbot instance in `.earwigbot` (run `earwigbot .earwigbot`). In
+  `.earwigbot/config.yml`, fill out the connection info for the database(s)
+  above by adding the following to the `wiki` section:
+        _copyviosSQL:
+            globals:
+                host: <hostname of database defined in schema.sql>
+                db:   <name of database>
+            cache:
+                host: <hostname of database containing cache and cache_data tables>
+                db:   <name of database>
+  If additional arguments are needed by `oursql.connect()`, like usernames or
+  passwords, they should be added to the `globals` and `cache` sections.
+- Copy `.lighttpd.conf` to the relevant location (on Tool Labs, this is in the
+  root of the project's home directory) and adjust its contents as necessary.
 - Run `./build.py` to minify JS and CSS files.
-- Start lighttpd.
+- Adjust the hashbang in `app.fcgi` to point to the correct Python interpreter
+  or virtual environment.
+- Start lighttpd (on Tool Labs, `webservice start`).