1 files changed, 45 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..ab1e1cb
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,45 @@
+# Ocelot
+
+Ocelot is a BitTorrent tracker written in C++ for the [Gazelle](http://whatcd.github.io/Gazelle/) project. It supports requests over TCP and can only track IPv4 peers.
+
+## Ocelot Compile-time Dependencies
+
+* [GCC/G++](http://gcc.gnu.org/) (4.7+ required; 4.8.1+ recommended)
+* [Boost](http://www.boost.org/) (1.55.0+ required)
+* [libev](http://software.schmorp.de/pkg/libev.html) (required)
+* [MySQL++](http://tangentsoft.net/mysql++/) (3.2.0+ required)
+* [TCMalloc](http://goog-perftools.sourceforge.net/doc/tcmalloc.html) (optional, but strongly recommended)
+
+## Installation
+
+The [Gazelle installation guides](https://github.com/WhatCD/Gazelle/wiki/Gazelle-installation) include instructions for installing Ocelot as a part of the Gazelle project.
+
+### Standalone Installation
+
+* Create the following tables according to the [Gazelle database schema](https://raw.githubusercontent.com/WhatCD/Gazelle/master/gazelle.sql):
+ - `torrents`
+ - `users_freeleeches`
+ - `users_main`
+ - `xbt_client_whitelist`
+ - `xbt_files_users`
+ - `xbt_snatched`
+
+* Edit `ocelot.conf` to your liking.
+
+* Build Ocelot:
+
+        ./configure
+        make
+        make install
+
+## Running Ocelot
+
+### Run-time options:
+
+* `-c <path/to/ocelot.conf>` - Path to config file. If unspecified, the current working directory is used.
+* `-v` - Print queue status every time a flush is initiated.
+
+### Signals
+
+* `SIGHUP` - Reload config
+* `SIGUSR1` - Reload torrent list, user list and client whitelist