From 429f77e4dae05dcce75f403e1bb718a5a82805fc Mon Sep 17 00:00:00 2001
From: Valentin Lorentz <progval@progval.net>
Date: Sat, 19 Dec 2015 23:57:22 +0100
Subject: [PATCH] Update README.

---
 README.md | 33 +++++++++++++++++++++++++++++----
 1 file changed, 29 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 7e8f54c..6274f8f 100644
--- a/README.md
+++ b/README.md
@@ -10,18 +10,30 @@ It is very young and does not contain a lot of test cases yet.
 
 This project contains:
 
-* IRC protocol test cases (only for clients for the moment)
+* IRC protocol test cases
 * small wrappers around existing software to run tests on them
-  (only Limnoria and Sopel for the moment)
+  (only Limnoria, Sopel, and InspIRCd for the moment)
 
-## How to use it
+Wrappers run software in temporary directories, so running `irctest` should
+have no side effect, with [the exception of Sopel](https://github.com/sopel-irc/sopel/issues/946).
 
-First, install dependencies:
+## Prerequisites
+
+
+Install dependencies:
 
 ```
 pip3 install --user -r requirements.txt
 ```
 
+Add `~/.local/bin/` to your `PATH` if it is not.
+
+```
+export PATH=$HOME/.local/bin/:$PATH
+```
+
+## Run tests
+
 To run tests with Limnoria:
 
 ```
@@ -36,3 +48,16 @@ pip3 install --user sopel
 mkdir ~/.sopel/
 python3 -m irctest irctest.controllers.sopel
 ```
+
+To run tests with InspIRCd:
+
+```
+cd /tmp/
+wget git clone git@github.com:inspircd/inspircd.git
+cd inspircd
+./configure --prefix=$HOME/.local/ --development
+make -j 4
+make install
+python3 -m irctest irctest.controllers.inspircd
+```
+```