summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohnny Richard <johnny@johnnyrichard.com>2022-04-12 03:33:59 +0200
committerJohnny Richard <johnny@johnnyrichard.com>2022-04-12 04:09:22 +0200
commit22283ef54b66495e2c88e0dbac9856c4a34434a6 (patch)
tree8f286885f00173b938213067776d34917e446386 /README.md
parente83f1e89da0a8fb5527435a61743b9f0769caa7c (diff)
Add munit testing framework support
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e267ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+PAPO IRC Server
+===============
+
+Minimal IRC Server implementation.
+
+DEVELOPMENT
+-----------
+
+Requirements
+
+ 1. gcc
+ 2. python3
+
+### Compiling
+
+ $ make
+
+### 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
+
+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.
+
+---
+
+Links:
+[^1]: ~johnnyrichard/papo-devel@lists.sr.ht
+[^2]: https://man.sr.ht/lists.sr.ht/etiquette.md