From 6684c285a074dea581d69d7bf3406ca9ce2bca82 Mon Sep 17 00:00:00 2001 From: Al Beano Date: Tue, 5 Jul 2016 12:50:49 +0100 Subject: [PATCH] details on dependencies --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f5b629..3037bc2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,19 @@ The original shithead uses far too much ram and is badly implemented. Let's reimplement it and get redis to do all the heavy lifting. ## Getting Started -A brainfile is simply an irc log with all joins, parts, timestamps and nicknames stripped. In other words, it contains only what was said. +First, set up dependencies. You need a redis server running locally (currently, AUTH and remote servers are not supported, this will be supported in the future) and the necessary perl modules: + +```bash +# install cpanminus with your package manager of choice (preferred), or install it through cpan: +cpan App::cpanminus +# clone the git repo if you haven't already, then install the perl modules +git clone https://neetco.de/albino/shithead-ng +cpanm --installdeps shithead-ng +# or, to avoid setting up local::lib: +cpanm --sudo --installdeps shithead-ng +``` + +Next, you need a brainfile. A brainfile is simply an irc log with all joins, parts, timestamps and nicknames stripped. In other words, it contains only what was said. ```bash # if you have an old brainfile, import it into redis