diff options
| author | Johnny Richard <johnny@johnnyrichard.com> | 2022-04-13 00:00:34 +0200 |
|---|---|---|
| committer | Johnny Richard <johnny@johnnyrichard.com> | 2022-04-13 00:00:34 +0200 |
| commit | a1148b9c8102ac8ffb9f8ebcd270e19bd72cb942 (patch) | |
| tree | 8c0ccfae95d5bc223a6fc0d20cd43c290e410448 | |
| parent | 22283ef54b66495e2c88e0dbac9856c4a34434a6 (diff) | |
docs: Improve README doc add testing instructions
| -rw-r--r-- | README.md | 20 |
1 files changed, 13 insertions, 7 deletions
@@ -1,7 +1,8 @@ -PAPO IRC Server -=============== +Papo - Minimal IRC Server implementation +======================================== -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 ----------- @@ -9,7 +10,7 @@ DEVELOPMENT Requirements 1. gcc - 2. python3 + 2. make ### Compiling @@ -17,11 +18,19 @@ Requirements ### 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 ---------- @@ -29,8 +38,5 @@ 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 |