From 1c7d0a60183d5de9dabab8cf5749369298c22935 Mon Sep 17 00:00:00 2001 From: retoor Date: Thu, 28 Nov 2024 19:02:57 +0100 Subject: [PATCH] Readme file update. --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index e69de29..e47cd10 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,32 @@ +# Isspam +Fast as light evaluator for text files to summarize specific details about the text files. + +## Building +``` +make build +``` +## Running +### Using files as parameter +``` +./isspam ./spam/*.txt +./isspam ./not_spam/*.txt +``` +### Using stdin +Useful for automation. +``` +cat ./spam/example_spam1.txt | ./isspam +``` +## Valgrind status +Date: 2024-11-28 +``` +Memory usage: 1 MB, 6.460 (re)allocated, 4.222 unqiue free'd, 0 in use. +==131498== +==131498== HEAP SUMMARY: +==131498== in use at exit: 0 bytes in 0 blocks +==131498== total heap usage: 6,486 allocs, 6,486 frees, 2,342,294 bytes allocated +==131498== +==131498== All heap blocks were freed -- no leaks are possible +==131498== +==131498== For lists of detected and suppressed errors, rerun with: -s +==131498== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0) +``` \ No newline at end of file