summaryrefslogtreecommitdiff
path: root/README.md
blob: 5086547a65622fdd16482850bcac14a88effd4fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Papo - Minimal IRC Server implementation
========================================

This is a work in progress, relatively untested and might be abandoned in the
near future. Use at your own risk.

DEVELOPMENT
-----------

Requirements

 1. gcc
 2. make

### Compiling

    $ make

### Testing

*Unit testing*

Make sure you have unit submodule cloned before run tests. You can run `git
submodule update --init` to get the submodules cloned.

    $ make test

*Functional testing*

Python3 is required to be able to run.

    $ make ftest

CONTRIBUTE
----------

We accept patches on our mailing list[^1] (use git-send-email to avoid issues
with your patches). We recommend you to follow the mailing etiquette[^2] before
send/reply emails to our mailing list.

[^1]: ~johnnyrichard/papo-devel@lists.sr.ht
[^2]: https://man.sr.ht/lists.sr.ht/etiquette.md