diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
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 |