val/irctest
1
0
Fork 0
mirror of https://github.com/progval/irctest.git synced 2025-04-05 14:59:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.

Browse Source
This commit is contained in:
Valentin Lorentz
2015-12-19 23:57:22 +01:00
parent 7a4cc47d9c
commit 429f77e4da
1 changed files with 29 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -10,18 +10,30 @@ It is very young and does not contain a lot of test cases yet.
This project contains: 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 * 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 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: To run tests with Limnoria:
``` ```
@ -36,3 +48,16 @@ pip3 install --user sopel
mkdir ~/.sopel/ mkdir ~/.sopel/
python3 -m irctest irctest.controllers.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
```
```